Start of Tutorial > Start of Trail |
Search
Feedback Form |
The polymorphic algorithms described in this section are pieces of reusable functionality provided by the JDK. All of them come from theCollections
class. All take the form of static methods whose first argument is the collection on which the operation is to be performed. The great majority of the algorithms provided by the Java platform operate onList
objects, but a couple of them (min
andmax
) operate on arbitraryCollection
objects. The algorithms are described below.
Thesort
algorithm reorders aList
so that its elements are ascending order according to some ordering relation. Two forms of the operation are provided. The simple form just takes aList
and sorts it according to its elements' natural ordering. If you're unfamiliar with the concept of natural ordering, now would be a good time to read the Object Ordering section.The
sort
operation uses a slightly optimized merge sort algorithm. If you don't know what this means but you do care, see any basic textbook on algorithms. The important things to know about this algorithm are that it is:Here's
- Fast: This algorithm is guaranteed to run in
n log(n)
time, and runs substantially faster on nearly sorted lists. Empirical studies showed it to be as fast as a highly optimized quicksort. Quicksort is generally regarded to be faster than merge sort, but isn't stable, and doesn't guaranteen log(n)
performance.- Stable: That is to say, it doesn't reorder equal elements. This is important if you sort the same list repeatedly on different attributes. If a user of a mail program sorts his in-box by mailing date, and then sorts it by sender, the user naturally expects that the now-contiguous list of messages from a given sender will (still) be sorted by mailing date. This is only guaranteed if the second sort was stable.
a trivial little program
that prints out its arguments in lexicographic (alphabetical) order.Let's run the program:import java.util.*; public class Sort { public static void main(String args[]) { List l = Arrays.asList(args); Collections.sort(l); System.out.println(l); } }The program was included only to show you that I have nothing up my sleeve: The algorithms really are as easy to use as they appear to be. I won't insult your intelligence by including any more silly examples.% java Sort i walk the line [i, line, the, walk]The second form of
sort
takes aComparator
in addition to aList
and sorts the elements with theComparator
. Remember the permutation group example at the end of theMap
section? It printed out the permutation groups in no particular order. Suppose you wanted to print them out in reverse order of size, largest permutation group first. The following example below shows you how to achieve this with the help of the second form of thesort
method.Recall that the permutation groups are stored as values in a
Map
, in the form ofList
objects. The revised printing code iterates through theMap
'svalues
-view, putting everyList
that passes the minimum-size test into aList
ofList
s. Then, the code sorts thisList
using aComparator
that expectsList
objects, and implements reverse-size ordering. Finally, the code iterates through the now-sortedList
, printing its elements (the permutation groups). This code replaces the printing code at the end ofPerm
'smain
method:Running// Make a List of all permutation groups above size threshold List winners = new ArrayList(); for (Iterator i = m.values().iterator(); i.hasNext(); ) { List l = (List) i.next(); if (l.size() >= minGroupSize) winners.add(l); } // Sort permutation groups according to size Collections.sort(winners, new Comparator() { public int compare(Object o1, Object o2) { return ((List)o2).size() - ((List)o1).size(); } }); // Print permutation groups for (Iterator i=winners.iterator(); i.hasNext(); ) { List l = (List) i.next(); System.out.println(l.size() + ": " + l); }this program
on the same dictionary in theMap
section, with the same minimum permutation group size (eight) produces the following output:% java Perm2 dictionary.txt 8 12: [apers, apres, asper, pares, parse, pears, prase, presa, rapes, reaps, spare, spear] 11: [alerts, alters, artels, estral, laster, ratels, salter, slater, staler, stelar, talers] 10: [least, setal, slate, stale, steal, stela, taels, tales, teals, tesla] 9: [estrin, inerts, insert, inters, niters, nitres, sinter, triens, trines] 9: [capers, crapes, escarp, pacers, parsec, recaps, scrape, secpar, spacer] 9: [anestri, antsier, nastier, ratines, retains, retinas, retsina, stainer, stearin] 9: [palest, palets, pastel, petals, plates, pleats, septal, staple, tepals] 8: [carets, cartes, caster, caters, crates, reacts, recast, traces] 8: [ates, east, eats, etas, sate, seat, seta, teas] 8: [arles, earls, lares, laser, lears, rales, reals, seral] 8: [lapse, leaps, pales, peals, pleas, salep, sepal, spale] 8: [aspers, parses, passer, prases, repass, spares, sparse, spears] 8: [earings, erasing, gainers, reagins, regains, reginas, searing, seringa] 8: [enters, nester, renest, rentes, resent, tenser, ternes, treens] 8: [peris, piers, pries, prise, ripes, speir, spier, spire]
Theshuffle
algorithm does the opposite of whatsort
does: it destroys any trace of order that may have been present in aList
. That is to say, it reorders theList
, based on input from a source of randomness, such that all possible permutations occur with equal likelihood (assuming a fair source of randomness). This algorithm is useful in implementing games of chance. For example, it could be used to shuffle aList
ofCard
objects representing a deck. Also, it's useful for generating test cases.There are two forms of this operation. The first just takes a
List
and uses a default source of randomness. The second requires the caller to provide a Randomobject to use as a source of randomness. The actual code for this algorithm is used as an example in theList
section.
TheCollections
class provides three algorithms for doing routine data manipulation onList
objects. All of these algorithms are pretty straightforward:
reverse
: Reverses the order of the elements in a List.fill
: Overwrites every element in aList
with the specified value. This operation is useful for re-initializing aList
.copy
: Takes two arguments, a destinationList
and a sourceList
, and copies the elements of the source into the destination, overwriting its contents. The destinationList
must be at least as long as the source. If it is longer, the remaining elements in the destinationList
are unaffected.
ThebinarySearch
algorithm searches for a specified element in a sortedList
using the binary search algorithm. There are two forms of this algorithm. The first takes aList
and an element to search for (the "search key"). This form assumes that theList
is sorted into ascending order according to the natural ordering of its elements. The second form of the call takes aComparator
in addition to theList
and the search key, and assumes that theList
is sorted into ascending order according to the specifiedComparator
. Thesort
algorithm (described above) can be used to sort theList
prior to callingbinarySearch
.The return value is the same for both forms: if the
List
contains the search key, its index is returned. If not, the return value is(-(insertion point) - 1)
, where the insertion point is defined as the point at which the value would be inserted into the List: the index of the first element greater than the value, orlist.size()
if all elements in theList
are less than the specified value. This admittedly ugly formula was chosen to guarantee that the return value will be >= 0 if and only if the search key is found. It's basically a hack to combine a boolean ("found") and an integer ("index") into a singleint
return value.The following idiom, usable with both forms of the
binarySearch
operation, looks for the specified search key, and inserts it at the appropriate position if it's not already present:int pos = Collections.binarySearch(l, key); if (pos < 0) l.add(-pos-1, key);
Themin
andmax
algorithms return, respectively, the minimum and maximum element contained in a specifiedCollection
. Both of these operations come in two forms. The simple form takes only aCollection
, and returns the minimum (or maximum) element according to the elements' natural ordering. The second form takes aComparator
in addition to theCollection
and returns the minimum (or maximum) element according to the specifiedComparator
.These are the only algorithms provided by the Java platform that work on arbitrary
Collection
objects, as opposed toList
objects. Like thefill
algorithm above, these algorithms are quite straightforward to implement. They are included in the Java platform solely as a convenience to programmers.
Start of Tutorial > Start of Trail |
Search
Feedback Form |