blob: cbfa806baa20bee012c49f453c6db7f2a1a24046 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Fri Apr 14 22:10:58 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractSet (Mahout Math 0.13.0 API)</title>
<meta name="date" content="2017-04-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractSet (Mahout Math 0.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":6,"i6":10,"i7":9,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractSet.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/mahout/math/set/AbstractLongSet.html" title="class in org.apache.mahout.math.set"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mahout/math/set/AbstractShortSet.html" title="class in org.apache.mahout.math.set"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/math/set/AbstractSet.html" target="_top">Frames</a></li>
<li><a href="AbstractSet.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.mahout.math.set</div>
<h2 title="Class AbstractSet" class="title">Class AbstractSet</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/mahout/math/PersistentObject.html" title="class in org.apache.mahout.math">org.apache.mahout.math.PersistentObject</a></li>
<li>
<ul class="inheritance">
<li>org.apache.mahout.math.set.AbstractSet</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/mahout/math/map/AbstractByteByteMap.html" title="class in org.apache.mahout.math.map">AbstractByteByteMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractByteCharMap.html" title="class in org.apache.mahout.math.map">AbstractByteCharMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractByteDoubleMap.html" title="class in org.apache.mahout.math.map">AbstractByteDoubleMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractByteFloatMap.html" title="class in org.apache.mahout.math.map">AbstractByteFloatMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractByteIntMap.html" title="class in org.apache.mahout.math.map">AbstractByteIntMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractByteLongMap.html" title="class in org.apache.mahout.math.map">AbstractByteLongMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractByteObjectMap.html" title="class in org.apache.mahout.math.map">AbstractByteObjectMap</a>, <a href="../../../../../org/apache/mahout/math/set/AbstractByteSet.html" title="class in org.apache.mahout.math.set">AbstractByteSet</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractByteShortMap.html" title="class in org.apache.mahout.math.map">AbstractByteShortMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractCharByteMap.html" title="class in org.apache.mahout.math.map">AbstractCharByteMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractCharCharMap.html" title="class in org.apache.mahout.math.map">AbstractCharCharMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractCharDoubleMap.html" title="class in org.apache.mahout.math.map">AbstractCharDoubleMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractCharFloatMap.html" title="class in org.apache.mahout.math.map">AbstractCharFloatMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractCharIntMap.html" title="class in org.apache.mahout.math.map">AbstractCharIntMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractCharLongMap.html" title="class in org.apache.mahout.math.map">AbstractCharLongMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractCharObjectMap.html" title="class in org.apache.mahout.math.map">AbstractCharObjectMap</a>, <a href="../../../../../org/apache/mahout/math/set/AbstractCharSet.html" title="class in org.apache.mahout.math.set">AbstractCharSet</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractCharShortMap.html" title="class in org.apache.mahout.math.map">AbstractCharShortMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractDoubleByteMap.html" title="class in org.apache.mahout.math.map">AbstractDoubleByteMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractDoubleCharMap.html" title="class in org.apache.mahout.math.map">AbstractDoubleCharMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractDoubleDoubleMap.html" title="class in org.apache.mahout.math.map">AbstractDoubleDoubleMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractDoubleFloatMap.html" title="class in org.apache.mahout.math.map">AbstractDoubleFloatMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractDoubleIntMap.html" title="class in org.apache.mahout.math.map">AbstractDoubleIntMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractDoubleLongMap.html" title="class in org.apache.mahout.math.map">AbstractDoubleLongMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractDoubleObjectMap.html" title="class in org.apache.mahout.math.map">AbstractDoubleObjectMap</a>, <a href="../../../../../org/apache/mahout/math/set/AbstractDoubleSet.html" title="class in org.apache.mahout.math.set">AbstractDoubleSet</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractDoubleShortMap.html" title="class in org.apache.mahout.math.map">AbstractDoubleShortMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractFloatByteMap.html" title="class in org.apache.mahout.math.map">AbstractFloatByteMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractFloatCharMap.html" title="class in org.apache.mahout.math.map">AbstractFloatCharMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractFloatDoubleMap.html" title="class in org.apache.mahout.math.map">AbstractFloatDoubleMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractFloatFloatMap.html" title="class in org.apache.mahout.math.map">AbstractFloatFloatMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractFloatIntMap.html" title="class in org.apache.mahout.math.map">AbstractFloatIntMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractFloatLongMap.html" title="class in org.apache.mahout.math.map">AbstractFloatLongMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractFloatObjectMap.html" title="class in org.apache.mahout.math.map">AbstractFloatObjectMap</a>, <a href="../../../../../org/apache/mahout/math/set/AbstractFloatSet.html" title="class in org.apache.mahout.math.set">AbstractFloatSet</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractFloatShortMap.html" title="class in org.apache.mahout.math.map">AbstractFloatShortMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractIntByteMap.html" title="class in org.apache.mahout.math.map">AbstractIntByteMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractIntCharMap.html" title="class in org.apache.mahout.math.map">AbstractIntCharMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractIntDoubleMap.html" title="class in org.apache.mahout.math.map">AbstractIntDoubleMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractIntFloatMap.html" title="class in org.apache.mahout.math.map">AbstractIntFloatMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractIntIntMap.html" title="class in org.apache.mahout.math.map">AbstractIntIntMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractIntLongMap.html" title="class in org.apache.mahout.math.map">AbstractIntLongMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractIntObjectMap.html" title="class in org.apache.mahout.math.map">AbstractIntObjectMap</a>, <a href="../../../../../org/apache/mahout/math/set/AbstractIntSet.html" title="class in org.apache.mahout.math.set">AbstractIntSet</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractIntShortMap.html" title="class in org.apache.mahout.math.map">AbstractIntShortMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractLongByteMap.html" title="class in org.apache.mahout.math.map">AbstractLongByteMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractLongCharMap.html" title="class in org.apache.mahout.math.map">AbstractLongCharMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractLongDoubleMap.html" title="class in org.apache.mahout.math.map">AbstractLongDoubleMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractLongFloatMap.html" title="class in org.apache.mahout.math.map">AbstractLongFloatMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractLongIntMap.html" title="class in org.apache.mahout.math.map">AbstractLongIntMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractLongLongMap.html" title="class in org.apache.mahout.math.map">AbstractLongLongMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractLongObjectMap.html" title="class in org.apache.mahout.math.map">AbstractLongObjectMap</a>, <a href="../../../../../org/apache/mahout/math/set/AbstractLongSet.html" title="class in org.apache.mahout.math.set">AbstractLongSet</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractLongShortMap.html" title="class in org.apache.mahout.math.map">AbstractLongShortMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractObjectByteMap.html" title="class in org.apache.mahout.math.map">AbstractObjectByteMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractObjectCharMap.html" title="class in org.apache.mahout.math.map">AbstractObjectCharMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractObjectDoubleMap.html" title="class in org.apache.mahout.math.map">AbstractObjectDoubleMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractObjectFloatMap.html" title="class in org.apache.mahout.math.map">AbstractObjectFloatMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractObjectIntMap.html" title="class in org.apache.mahout.math.map">AbstractObjectIntMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractObjectLongMap.html" title="class in org.apache.mahout.math.map">AbstractObjectLongMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractObjectShortMap.html" title="class in org.apache.mahout.math.map">AbstractObjectShortMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractShortByteMap.html" title="class in org.apache.mahout.math.map">AbstractShortByteMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractShortCharMap.html" title="class in org.apache.mahout.math.map">AbstractShortCharMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractShortDoubleMap.html" title="class in org.apache.mahout.math.map">AbstractShortDoubleMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractShortFloatMap.html" title="class in org.apache.mahout.math.map">AbstractShortFloatMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractShortIntMap.html" title="class in org.apache.mahout.math.map">AbstractShortIntMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractShortLongMap.html" title="class in org.apache.mahout.math.map">AbstractShortLongMap</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractShortObjectMap.html" title="class in org.apache.mahout.math.map">AbstractShortObjectMap</a>, <a href="../../../../../org/apache/mahout/math/set/AbstractShortSet.html" title="class in org.apache.mahout.math.set">AbstractShortSet</a>, <a href="../../../../../org/apache/mahout/math/map/AbstractShortShortMap.html" title="class in org.apache.mahout.math.map">AbstractShortShortMap</a>, <a href="../../../../../org/apache/mahout/math/map/OpenHashMap.html" title="class in org.apache.mahout.math.map">OpenHashMap</a>, <a href="../../../../../org/apache/mahout/math/set/OpenHashSet.html" title="class in org.apache.mahout.math.set">OpenHashSet</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractSet</span>
extends <a href="../../../../../org/apache/mahout/math/PersistentObject.html" title="class in org.apache.mahout.math">PersistentObject</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.mahout.math.set.AbstractSet">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#DEFAULT_CAPACITY">DEFAULT_CAPACITY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#DEFAULT_MAX_LOAD_FACTOR">DEFAULT_MAX_LOAD_FACTOR</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#DEFAULT_MIN_LOAD_FACTOR">DEFAULT_MIN_LOAD_FACTOR</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#distinct">distinct</a></span></code>
<div class="block">The number of distinct associations in the map; its "size()".</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#highWaterMark">highWaterMark</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#lowWaterMark">lowWaterMark</a></span></code>
<div class="block">The table capacity c=table.length always satisfies the invariant <tt>c * minLoadFactor <= s <= c *
maxLoadFactor</tt>, where s=size() is the number of associations currently contained.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#maxLoadFactor">maxLoadFactor</a></span></code>
<div class="block">The maximum load factor for the hashtable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#minLoadFactor">minLoadFactor</a></span></code>
<div class="block">The minimum load factor for the hashtable.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#AbstractSet--">AbstractSet</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#chooseGrowCapacity-int-double-double-">chooseGrowCapacity</a></span>(int&nbsp;size,
double&nbsp;minLoad,
double&nbsp;maxLoad)</code>
<div class="block">Chooses a new prime table capacity optimized for growing that (approximately) satisfies the invariant <tt>c *
minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least one FREE slot for the given size.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#chooseHighWaterMark-int-double-">chooseHighWaterMark</a></span>(int&nbsp;capacity,
double&nbsp;maxLoad)</code>
<div class="block">Returns new high water mark threshold based on current capacity and maxLoadFactor.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#chooseLowWaterMark-int-double-">chooseLowWaterMark</a></span>(int&nbsp;capacity,
double&nbsp;minLoad)</code>
<div class="block">Returns new low water mark threshold based on current capacity and minLoadFactor.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#chooseMeanCapacity-int-double-double-">chooseMeanCapacity</a></span>(int&nbsp;size,
double&nbsp;minLoad,
double&nbsp;maxLoad)</code>
<div class="block">Chooses a new prime table capacity neither favoring shrinking nor growing, that (approximately) satisfies the
invariant <tt>c * minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least one FREE slot for the given
size.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#chooseShrinkCapacity-int-double-double-">chooseShrinkCapacity</a></span>(int&nbsp;size,
double&nbsp;minLoad,
double&nbsp;maxLoad)</code>
<div class="block">Chooses a new prime table capacity optimized for shrinking that (approximately) satisfies the invariant <tt>c *
minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least one FREE slot for the given size.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#clear--">clear</a></span>()</code>
<div class="block">Removes all (key,value) associations from the receiver.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#ensureCapacity-int-">ensureCapacity</a></span>(int&nbsp;minCapacity)</code>
<div class="block">Ensures that the receiver can hold at least the specified number of elements without needing to allocate new
internal memory.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#equalsMindTheNull-java.lang.Object-java.lang.Object-">equalsMindTheNull</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;a,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;b)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#isEmpty--">isEmpty</a></span>()</code>
<div class="block">Returns <tt>true</tt> if the receiver contains no (key,value) associations.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#nextPrime-int-">nextPrime</a></span>(int&nbsp;desiredCapacity)</code>
<div class="block">Returns a prime number which is <code>&gt;= desiredCapacity</code> and very close to <code>desiredCapacity</code>
(within 11% if <code>desiredCapacity &gt;= 1000</code>).</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#setUp-int-double-double-">setUp</a></span>(int&nbsp;initialCapacity,
double&nbsp;minLoadFactor,
double&nbsp;maxLoadFactor)</code>
<div class="block">Initializes the receiver.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#size--">size</a></span>()</code>
<div class="block">Returns the number of (key,value) associations currently contained.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/math/set/AbstractSet.html#trimToSize--">trimToSize</a></span>()</code>
<div class="block">Trims the capacity of the receiver to be the receiver's current size.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.mahout.math.PersistentObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.mahout.math.<a href="../../../../../org/apache/mahout/math/PersistentObject.html" title="class in org.apache.mahout.math">PersistentObject</a></h3>
<code><a href="../../../../../org/apache/mahout/math/PersistentObject.html#clone--">clone</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="distinct">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>distinct</h4>
<pre>protected&nbsp;int distinct</pre>
<div class="block">The number of distinct associations in the map; its "size()".</div>
</li>
</ul>
<a name="lowWaterMark">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lowWaterMark</h4>
<pre>protected&nbsp;int lowWaterMark</pre>
<div class="block">The table capacity c=table.length always satisfies the invariant <tt>c * minLoadFactor <= s <= c *
maxLoadFactor</tt>, where s=size() is the number of associations currently contained. The term "c * minLoadFactor"
is called the "lowWaterMark", "c * maxLoadFactor" is called the "highWaterMark". In other words, the table capacity
(and proportionally the memory used by this class) oscillates within these constraints. The terms are precomputed
and cached to avoid recalculating them each time put(..) or removeKey(...) is called.</div>
</li>
</ul>
<a name="highWaterMark">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>highWaterMark</h4>
<pre>protected&nbsp;int highWaterMark</pre>
</li>
</ul>
<a name="minLoadFactor">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minLoadFactor</h4>
<pre>protected&nbsp;double minLoadFactor</pre>
<div class="block">The minimum load factor for the hashtable.</div>
</li>
</ul>
<a name="maxLoadFactor">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxLoadFactor</h4>
<pre>protected&nbsp;double maxLoadFactor</pre>
<div class="block">The maximum load factor for the hashtable.</div>
</li>
</ul>
<a name="DEFAULT_CAPACITY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CAPACITY</h4>
<pre>public static final&nbsp;int DEFAULT_CAPACITY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.mahout.math.set.AbstractSet.DEFAULT_CAPACITY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_MIN_LOAD_FACTOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MIN_LOAD_FACTOR</h4>
<pre>public static final&nbsp;double DEFAULT_MIN_LOAD_FACTOR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.mahout.math.set.AbstractSet.DEFAULT_MIN_LOAD_FACTOR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_MAX_LOAD_FACTOR">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_MAX_LOAD_FACTOR</h4>
<pre>public static final&nbsp;double DEFAULT_MAX_LOAD_FACTOR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.mahout.math.set.AbstractSet.DEFAULT_MAX_LOAD_FACTOR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractSet--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractSet</h4>
<pre>public&nbsp;AbstractSet()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="chooseGrowCapacity-int-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>chooseGrowCapacity</h4>
<pre>protected&nbsp;int&nbsp;chooseGrowCapacity(int&nbsp;size,
double&nbsp;minLoad,
double&nbsp;maxLoad)</pre>
<div class="block">Chooses a new prime table capacity optimized for growing that (approximately) satisfies the invariant <tt>c *
minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least one FREE slot for the given size.</div>
</li>
</ul>
<a name="chooseHighWaterMark-int-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>chooseHighWaterMark</h4>
<pre>protected&nbsp;int&nbsp;chooseHighWaterMark(int&nbsp;capacity,
double&nbsp;maxLoad)</pre>
<div class="block">Returns new high water mark threshold based on current capacity and maxLoadFactor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>int the new threshold.</dd>
</dl>
</li>
</ul>
<a name="chooseLowWaterMark-int-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>chooseLowWaterMark</h4>
<pre>protected&nbsp;int&nbsp;chooseLowWaterMark(int&nbsp;capacity,
double&nbsp;minLoad)</pre>
<div class="block">Returns new low water mark threshold based on current capacity and minLoadFactor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>int the new threshold.</dd>
</dl>
</li>
</ul>
<a name="chooseMeanCapacity-int-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>chooseMeanCapacity</h4>
<pre>protected&nbsp;int&nbsp;chooseMeanCapacity(int&nbsp;size,
double&nbsp;minLoad,
double&nbsp;maxLoad)</pre>
<div class="block">Chooses a new prime table capacity neither favoring shrinking nor growing, that (approximately) satisfies the
invariant <tt>c * minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least one FREE slot for the given
size.</div>
</li>
</ul>
<a name="chooseShrinkCapacity-int-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>chooseShrinkCapacity</h4>
<pre>protected&nbsp;int&nbsp;chooseShrinkCapacity(int&nbsp;size,
double&nbsp;minLoad,
double&nbsp;maxLoad)</pre>
<div class="block">Chooses a new prime table capacity optimized for shrinking that (approximately) satisfies the invariant <tt>c *
minLoadFactor <= size <= c * maxLoadFactor</tt> and has at least one FREE slot for the given size.</div>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public abstract&nbsp;void&nbsp;clear()</pre>
<div class="block">Removes all (key,value) associations from the receiver.</div>
</li>
</ul>
<a name="ensureCapacity-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ensureCapacity</h4>
<pre>public&nbsp;void&nbsp;ensureCapacity(int&nbsp;minCapacity)</pre>
<div class="block">Ensures that the receiver can hold at least the specified number of elements without needing to allocate new
internal memory. If necessary, allocates new internal memory and increases the capacity of the receiver. <p> This
method never need be called; it is for performance tuning only. Calling this method before <tt>put()</tt>ing a
large number of associations boosts performance, because the receiver will grow only once instead of potentially
many times. <p> <b>This default implementation does nothing.</b> Override this method if necessary.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>minCapacity</code> - the desired minimum capacity.</dd>
</dl>
</li>
</ul>
<a name="isEmpty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public&nbsp;boolean&nbsp;isEmpty()</pre>
<div class="block">Returns <tt>true</tt> if the receiver contains no (key,value) associations.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><tt>true</tt> if the receiver contains no (key,value) associations.</dd>
</dl>
</li>
</ul>
<a name="nextPrime-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextPrime</h4>
<pre>protected&nbsp;int&nbsp;nextPrime(int&nbsp;desiredCapacity)</pre>
<div class="block">Returns a prime number which is <code>&gt;= desiredCapacity</code> and very close to <code>desiredCapacity</code>
(within 11% if <code>desiredCapacity &gt;= 1000</code>).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>desiredCapacity</code> - the capacity desired by the user.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the capacity which should be used for a hashtable.</dd>
</dl>
</li>
</ul>
<a name="setUp-int-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUp</h4>
<pre>protected&nbsp;void&nbsp;setUp(int&nbsp;initialCapacity,
double&nbsp;minLoadFactor,
double&nbsp;maxLoadFactor)</pre>
<div class="block">Initializes the receiver. You will almost certainly need to override this method in subclasses to initialize the
hash table.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>initialCapacity</code> - the initial capacity of the receiver.</dd>
<dd><code>minLoadFactor</code> - the minLoadFactor of the receiver.</dd>
<dd><code>maxLoadFactor</code> - the maxLoadFactor of the receiver.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) ||
(maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >=
maxLoadFactor)</tt>.</dd>
</dl>
</li>
</ul>
<a name="size--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public&nbsp;int&nbsp;size()</pre>
<div class="block">Returns the number of (key,value) associations currently contained.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of (key,value) associations currently contained.</dd>
</dl>
</li>
</ul>
<a name="trimToSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trimToSize</h4>
<pre>public&nbsp;void&nbsp;trimToSize()</pre>
<div class="block">Trims the capacity of the receiver to be the receiver's current size. Releases any superfluous internal memory. An
application can use this operation to minimize the storage of the receiver. <p> This default implementation does
nothing. Override this method if necessary.</div>
</li>
</ul>
<a name="equalsMindTheNull-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>equalsMindTheNull</h4>
<pre>protected static&nbsp;boolean&nbsp;equalsMindTheNull(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;a,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;b)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractSet.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/mahout/math/set/AbstractLongSet.html" title="class in org.apache.mahout.math.set"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mahout/math/set/AbstractShortSet.html" title="class in org.apache.mahout.math.set"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/math/set/AbstractSet.html" target="_top">Frames</a></li>
<li><a href="AbstractSet.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>