org.crosswire.common.util
Class Histogram

java.lang.Object
  org.crosswire.common.util.Histogram

public class Histogram
extends Object

A simple implementation of a histogram. It would be nice to enhance it to order on frequency.

Distribution Licence:
JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
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.
The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
The copyright to this program is held by it's authors.

Version:

$Id: Histogram.java,v 1.3 2005/03/06 20:21:59 dmsmith Exp $

Author:

DM Smith [ dmsmith555 at yahoo dot com]

See Also:

Licence

Nested Class Summary

private static class

Histogram.Counter Trivial mutable counting integer class.

Field Summary

private Map

hist

Constructor Summary

Histogram()
Create an empty histogram

Method Summary

void	clear()
void	increment(String key) note that this key has been seen one time more than before.
String	toString() The format of the histogram is an unordered list of string and the counts of the number of times it has been seen.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

hist

private Map hist

Constructor Detail

Histogram

public Histogram()

Create an empty histogram

Method Detail

increment

public void increment(String key)

note that this key has been seen one time more than before.

Parameters:

key -

clear

public void clear()

toString

public String toString()

The format of the histogram is an unordered list of string and the counts of the number of times it has been seen.

Overrides:

toString in class Object

Returns:

the resultant histogram

See Also:

Object.toString()