|
| 1 | +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| 2 | +<!-- NewPage --> |
| 3 | +<html lang="en"> |
| 4 | +<head> |
| 5 | +<!-- Generated by javadoc (1.8.0_111) on Mon Dec 24 17:46:55 EST 2018 --> |
| 6 | +<title>Bag</title> |
| 7 | +<meta name="date" content="2018-12-24"> |
| 8 | +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> |
| 9 | +<script type="text/javascript" src="script.js"></script> |
| 10 | +</head> |
| 11 | +<body> |
| 12 | +<script type="text/javascript"><!-- |
| 13 | + try { |
| 14 | + if (location.href.indexOf('is-external=true') == -1) { |
| 15 | + parent.document.title="Bag"; |
| 16 | + } |
| 17 | + } |
| 18 | + catch(err) { |
| 19 | + } |
| 20 | +//--> |
| 21 | +var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; |
| 22 | +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| 23 | +var altColor = "altColor"; |
| 24 | +var rowColor = "rowColor"; |
| 25 | +var tableTab = "tableTab"; |
| 26 | +var activeTableTab = "activeTableTab"; |
| 27 | +</script> |
| 28 | +<noscript> |
| 29 | +<div>JavaScript is disabled on your browser.</div> |
| 30 | +</noscript> |
| 31 | +<!-- ========= START OF TOP NAVBAR ======= --> |
| 32 | +<div class="topNav"><a name="navbar.top"> |
| 33 | +<!-- --> |
| 34 | +</a> |
| 35 | +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| 36 | +<a name="navbar.top.firstrow"> |
| 37 | +<!-- --> |
| 38 | +</a> |
| 39 | +<ul class="navList" title="Navigation"> |
| 40 | +<li><a href="package-summary.html">Package</a></li> |
| 41 | +<li class="navBarCell1Rev">Class</li> |
| 42 | +<li><a href="package-tree.html">Tree</a></li> |
| 43 | +<li><a href="deprecated-list.html">Deprecated</a></li> |
| 44 | +<li><a href="index-all.html">Index</a></li> |
| 45 | +<li><a href="help-doc.html">Help</a></li> |
| 46 | +</ul> |
| 47 | +</div> |
| 48 | +<div class="subNav"> |
| 49 | +<ul class="navList"> |
| 50 | +<li>Prev Class</li> |
| 51 | +<li><a href="CC.html" title="class in <Unnamed>"><span class="typeNameLink">Next Class</span></a></li> |
| 52 | +</ul> |
| 53 | +<ul class="navList"> |
| 54 | +<li><a href="index.html?Bag.html" target="_top">Frames</a></li> |
| 55 | +<li><a href="Bag.html" target="_top">No Frames</a></li> |
| 56 | +</ul> |
| 57 | +<ul class="navList" id="allclasses_navbar_top"> |
| 58 | +<li><a href="allclasses-noframe.html">All Classes</a></li> |
| 59 | +</ul> |
| 60 | +<div> |
| 61 | +<script type="text/javascript"><!-- |
| 62 | + allClassesLink = document.getElementById("allclasses_navbar_top"); |
| 63 | + if(window==top) { |
| 64 | + allClassesLink.style.display = "block"; |
| 65 | + } |
| 66 | + else { |
| 67 | + allClassesLink.style.display = "none"; |
| 68 | + } |
| 69 | + //--> |
| 70 | +</script> |
| 71 | +</div> |
| 72 | +<div> |
| 73 | +<ul class="subNavList"> |
| 74 | +<li>Summary: </li> |
| 75 | +<li>Nested | </li> |
| 76 | +<li>Field | </li> |
| 77 | +<li><a href="#constructor.summary">Constr</a> | </li> |
| 78 | +<li><a href="#method.summary">Method</a></li> |
| 79 | +</ul> |
| 80 | +<ul class="subNavList"> |
| 81 | +<li>Detail: </li> |
| 82 | +<li>Field | </li> |
| 83 | +<li><a href="#constructor.detail">Constr</a> | </li> |
| 84 | +<li><a href="#method.detail">Method</a></li> |
| 85 | +</ul> |
| 86 | +</div> |
| 87 | +<a name="skip.navbar.top"> |
| 88 | +<!-- --> |
| 89 | +</a></div> |
| 90 | +<!-- ========= END OF TOP NAVBAR ========= --> |
| 91 | +<!-- ======== START OF CLASS DATA ======== --> |
| 92 | +<div class="header"> |
| 93 | +<h2 title="Class Bag" class="title">Class Bag<Item></h2> |
| 94 | +</div> |
| 95 | +<div class="contentContainer"> |
| 96 | +<ul class="inheritance"> |
| 97 | +<li>java.lang.Object</li> |
| 98 | +<li> |
| 99 | +<ul class="inheritance"> |
| 100 | +<li>Bag<Item></li> |
| 101 | +</ul> |
| 102 | +</li> |
| 103 | +</ul> |
| 104 | +<div class="description"> |
| 105 | +<ul class="blockList"> |
| 106 | +<li class="blockList"> |
| 107 | +<dl> |
| 108 | +<dt><span class="paramLabel">Type Parameters:</span></dt> |
| 109 | +<dd><code>Item</code> - the generic type of an item in this bag</dd> |
| 110 | +</dl> |
| 111 | +<dl> |
| 112 | +<dt>All Implemented Interfaces:</dt> |
| 113 | +<dd>java.lang.Iterable<Item></dd> |
| 114 | +</dl> |
| 115 | +<hr> |
| 116 | +<br> |
| 117 | +<pre>public class <span class="typeNameLabel">Bag<Item></span> |
| 118 | +extends java.lang.Object |
| 119 | +implements java.lang.Iterable<Item></pre> |
| 120 | +<div class="block">The <code>Bag</code> class represents a bag (or multiset) of |
| 121 | + generic items. It supports insertion and iterating over the |
| 122 | + items in arbitrary order. |
| 123 | + <p> |
| 124 | + This implementation uses a singly linked list with a static nested class Node. |
| 125 | + See <code>LinkedBag</code> for the version from the |
| 126 | + textbook that uses a non-static nested class. |
| 127 | + See <code>ResizingArrayBag</code> for a version that uses a resizing array. |
| 128 | + The <em>add</em>, <em>isEmpty</em>, and <em>size</em> operations |
| 129 | + take constant time. Iteration takes time proportional to the number of items. |
| 130 | + <p> |
| 131 | + For additional documentation, see <a href="https://algs4.cs.princeton.edu/13stacks">Section 1.3</a> of |
| 132 | + <i>Algorithms, 4th Edition</i> by Robert Sedgewick and Kevin Wayne.</div> |
| 133 | +</li> |
| 134 | +</ul> |
| 135 | +</div> |
| 136 | +<div class="summary"> |
| 137 | +<ul class="blockList"> |
| 138 | +<li class="blockList"> |
| 139 | +<!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| 140 | +<ul class="blockList"> |
| 141 | +<li class="blockList"><a name="constructor.summary"> |
| 142 | +<!-- --> |
| 143 | +</a> |
| 144 | +<h3>Constructor Summary</h3> |
| 145 | +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| 146 | +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| 147 | +<tr> |
| 148 | +<th class="colOne" scope="col">Constructor and Description</th> |
| 149 | +</tr> |
| 150 | +<tr class="altColor"> |
| 151 | +<td class="colOne"><code><span class="memberNameLink"><a href="Bag.html#Bag--">Bag</a></span>()</code> |
| 152 | +<div class="block">Initializes an empty bag.</div> |
| 153 | +</td> |
| 154 | +</tr> |
| 155 | +</table> |
| 156 | +</li> |
| 157 | +</ul> |
| 158 | +<!-- ========== METHOD SUMMARY =========== --> |
| 159 | +<ul class="blockList"> |
| 160 | +<li class="blockList"><a name="method.summary"> |
| 161 | +<!-- --> |
| 162 | +</a> |
| 163 | +<h3>Method Summary</h3> |
| 164 | +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| 165 | +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| 166 | +<tr> |
| 167 | +<th class="colFirst" scope="col">Modifier and Type</th> |
| 168 | +<th class="colLast" scope="col">Method and Description</th> |
| 169 | +</tr> |
| 170 | +<tr id="i0" class="altColor"> |
| 171 | +<td class="colFirst"><code>void</code></td> |
| 172 | +<td class="colLast"><code><span class="memberNameLink"><a href="Bag.html#add-Item-">add</a></span>(<a href="Bag.html" title="type parameter in Bag">Item</a> item)</code> |
| 173 | +<div class="block">Adds the item to this bag.</div> |
| 174 | +</td> |
| 175 | +</tr> |
| 176 | +<tr id="i1" class="rowColor"> |
| 177 | +<td class="colFirst"><code>boolean</code></td> |
| 178 | +<td class="colLast"><code><span class="memberNameLink"><a href="Bag.html#isEmpty--">isEmpty</a></span>()</code> |
| 179 | +<div class="block">Returns true if this bag is empty.</div> |
| 180 | +</td> |
| 181 | +</tr> |
| 182 | +<tr id="i2" class="altColor"> |
| 183 | +<td class="colFirst"><code>java.util.Iterator<<a href="Bag.html" title="type parameter in Bag">Item</a>></code></td> |
| 184 | +<td class="colLast"><code><span class="memberNameLink"><a href="Bag.html#iterator--">iterator</a></span>()</code> |
| 185 | +<div class="block">Returns an iterator that iterates over the items in this bag in arbitrary order.</div> |
| 186 | +</td> |
| 187 | +</tr> |
| 188 | +<tr id="i3" class="rowColor"> |
| 189 | +<td class="colFirst"><code>int</code></td> |
| 190 | +<td class="colLast"><code><span class="memberNameLink"><a href="Bag.html#size--">size</a></span>()</code> |
| 191 | +<div class="block">Returns the number of items in this bag.</div> |
| 192 | +</td> |
| 193 | +</tr> |
| 194 | +</table> |
| 195 | +<ul class="blockList"> |
| 196 | +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| 197 | +<!-- --> |
| 198 | +</a> |
| 199 | +<h3>Methods inherited from class java.lang.Object</h3> |
| 200 | +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| 201 | +</ul> |
| 202 | +<ul class="blockList"> |
| 203 | +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable"> |
| 204 | +<!-- --> |
| 205 | +</a> |
| 206 | +<h3>Methods inherited from interface java.lang.Iterable</h3> |
| 207 | +<code>forEach, spliterator</code></li> |
| 208 | +</ul> |
| 209 | +</li> |
| 210 | +</ul> |
| 211 | +</li> |
| 212 | +</ul> |
| 213 | +</div> |
| 214 | +<div class="details"> |
| 215 | +<ul class="blockList"> |
| 216 | +<li class="blockList"> |
| 217 | +<!-- ========= CONSTRUCTOR DETAIL ======== --> |
| 218 | +<ul class="blockList"> |
| 219 | +<li class="blockList"><a name="constructor.detail"> |
| 220 | +<!-- --> |
| 221 | +</a> |
| 222 | +<h3>Constructor Detail</h3> |
| 223 | +<a name="Bag--"> |
| 224 | +<!-- --> |
| 225 | +</a> |
| 226 | +<ul class="blockListLast"> |
| 227 | +<li class="blockList"> |
| 228 | +<h4>Bag</h4> |
| 229 | +<pre>public Bag()</pre> |
| 230 | +<div class="block">Initializes an empty bag.</div> |
| 231 | +</li> |
| 232 | +</ul> |
| 233 | +</li> |
| 234 | +</ul> |
| 235 | +<!-- ============ METHOD DETAIL ========== --> |
| 236 | +<ul class="blockList"> |
| 237 | +<li class="blockList"><a name="method.detail"> |
| 238 | +<!-- --> |
| 239 | +</a> |
| 240 | +<h3>Method Detail</h3> |
| 241 | +<a name="isEmpty--"> |
| 242 | +<!-- --> |
| 243 | +</a> |
| 244 | +<ul class="blockList"> |
| 245 | +<li class="blockList"> |
| 246 | +<h4>isEmpty</h4> |
| 247 | +<pre>public boolean isEmpty()</pre> |
| 248 | +<div class="block">Returns true if this bag is empty.</div> |
| 249 | +<dl> |
| 250 | +<dt><span class="returnLabel">Returns:</span></dt> |
| 251 | +<dd><code>true</code> if this bag is empty; |
| 252 | + <code>false</code> otherwise</dd> |
| 253 | +</dl> |
| 254 | +</li> |
| 255 | +</ul> |
| 256 | +<a name="size--"> |
| 257 | +<!-- --> |
| 258 | +</a> |
| 259 | +<ul class="blockList"> |
| 260 | +<li class="blockList"> |
| 261 | +<h4>size</h4> |
| 262 | +<pre>public int size()</pre> |
| 263 | +<div class="block">Returns the number of items in this bag.</div> |
| 264 | +<dl> |
| 265 | +<dt><span class="returnLabel">Returns:</span></dt> |
| 266 | +<dd>the number of items in this bag</dd> |
| 267 | +</dl> |
| 268 | +</li> |
| 269 | +</ul> |
| 270 | +<a name="add-java.lang.Object-"> |
| 271 | +<!-- --> |
| 272 | +</a><a name="add-Item-"> |
| 273 | +<!-- --> |
| 274 | +</a> |
| 275 | +<ul class="blockList"> |
| 276 | +<li class="blockList"> |
| 277 | +<h4>add</h4> |
| 278 | +<pre>public void add(<a href="Bag.html" title="type parameter in Bag">Item</a> item)</pre> |
| 279 | +<div class="block">Adds the item to this bag.</div> |
| 280 | +<dl> |
| 281 | +<dt><span class="paramLabel">Parameters:</span></dt> |
| 282 | +<dd><code>item</code> - the item to add to this bag</dd> |
| 283 | +</dl> |
| 284 | +</li> |
| 285 | +</ul> |
| 286 | +<a name="iterator--"> |
| 287 | +<!-- --> |
| 288 | +</a> |
| 289 | +<ul class="blockListLast"> |
| 290 | +<li class="blockList"> |
| 291 | +<h4>iterator</h4> |
| 292 | +<pre>public java.util.Iterator<<a href="Bag.html" title="type parameter in Bag">Item</a>> iterator()</pre> |
| 293 | +<div class="block">Returns an iterator that iterates over the items in this bag in arbitrary order.</div> |
| 294 | +<dl> |
| 295 | +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| 296 | +<dd><code>iterator</code> in interface <code>java.lang.Iterable<<a href="Bag.html" title="type parameter in Bag">Item</a>></code></dd> |
| 297 | +<dt><span class="returnLabel">Returns:</span></dt> |
| 298 | +<dd>an iterator that iterates over the items in this bag in arbitrary order</dd> |
| 299 | +</dl> |
| 300 | +</li> |
| 301 | +</ul> |
| 302 | +</li> |
| 303 | +</ul> |
| 304 | +</li> |
| 305 | +</ul> |
| 306 | +</div> |
| 307 | +</div> |
| 308 | +<!-- ========= END OF CLASS DATA ========= --> |
| 309 | +<!-- ======= START OF BOTTOM NAVBAR ====== --> |
| 310 | +<div class="bottomNav"><a name="navbar.bottom"> |
| 311 | +<!-- --> |
| 312 | +</a> |
| 313 | +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| 314 | +<a name="navbar.bottom.firstrow"> |
| 315 | +<!-- --> |
| 316 | +</a> |
| 317 | +<ul class="navList" title="Navigation"> |
| 318 | +<li><a href="package-summary.html">Package</a></li> |
| 319 | +<li class="navBarCell1Rev">Class</li> |
| 320 | +<li><a href="package-tree.html">Tree</a></li> |
| 321 | +<li><a href="deprecated-list.html">Deprecated</a></li> |
| 322 | +<li><a href="index-all.html">Index</a></li> |
| 323 | +<li><a href="help-doc.html">Help</a></li> |
| 324 | +</ul> |
| 325 | +</div> |
| 326 | +<div class="subNav"> |
| 327 | +<ul class="navList"> |
| 328 | +<li>Prev Class</li> |
| 329 | +<li><a href="CC.html" title="class in <Unnamed>"><span class="typeNameLink">Next Class</span></a></li> |
| 330 | +</ul> |
| 331 | +<ul class="navList"> |
| 332 | +<li><a href="index.html?Bag.html" target="_top">Frames</a></li> |
| 333 | +<li><a href="Bag.html" target="_top">No Frames</a></li> |
| 334 | +</ul> |
| 335 | +<ul class="navList" id="allclasses_navbar_bottom"> |
| 336 | +<li><a href="allclasses-noframe.html">All Classes</a></li> |
| 337 | +</ul> |
| 338 | +<div> |
| 339 | +<script type="text/javascript"><!-- |
| 340 | + allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| 341 | + if(window==top) { |
| 342 | + allClassesLink.style.display = "block"; |
| 343 | + } |
| 344 | + else { |
| 345 | + allClassesLink.style.display = "none"; |
| 346 | + } |
| 347 | + //--> |
| 348 | +</script> |
| 349 | +</div> |
| 350 | +<div> |
| 351 | +<ul class="subNavList"> |
| 352 | +<li>Summary: </li> |
| 353 | +<li>Nested | </li> |
| 354 | +<li>Field | </li> |
| 355 | +<li><a href="#constructor.summary">Constr</a> | </li> |
| 356 | +<li><a href="#method.summary">Method</a></li> |
| 357 | +</ul> |
| 358 | +<ul class="subNavList"> |
| 359 | +<li>Detail: </li> |
| 360 | +<li>Field | </li> |
| 361 | +<li><a href="#constructor.detail">Constr</a> | </li> |
| 362 | +<li><a href="#method.detail">Method</a></li> |
| 363 | +</ul> |
| 364 | +</div> |
| 365 | +<a name="skip.navbar.bottom"> |
| 366 | +<!-- --> |
| 367 | +</a></div> |
| 368 | +<!-- ======== END OF BOTTOM NAVBAR ======= --> |
| 369 | +</body> |
| 370 | +</html> |
0 commit comments