org.apache.commons.math.stat
public class Frequency extends Object implements Serializable
Accepts int, long, char or Comparable values. New values added must be comparable to those that have been added, otherwise the add method will throw an IllegalArgumentException.
Integer values (int, long, Integer, Long) are not distinguished by type --
i.e. addValue(Long.valueOf(2)), addValue(2), addValue(2l)
all have
the same effect (similarly for arguments to getCount,
etc.).
char values are converted by addValue
to Character instances.
As such, these values are not comparable to integral values, so attempts
to combine integral types with chars in a frequency distribution will fail.
The values are ordered using the default (natural order), unless a
Comparator
is supplied in the constructor.
Modifier and Type | Class and Description |
---|---|
private static class |
Frequency.NaturalComparator<T extends Comparable<T>>
A Comparator that compares comparable objects using the
natural order.
|
Modifier and Type | Field and Description |
---|---|
private TreeMap<Comparable<?>,Long> |
freqTable
underlying collection
|
private static long |
serialVersionUID
Serializable version identifier
|
Constructor and Description |
---|
Frequency()
Default constructor.
|
Frequency(Comparator<?> comparator)
Constructor allowing values Comparator to be specified.
|
Modifier and Type | Method and Description |
---|---|
void |
addValue(char v)
Adds 1 to the frequency count for v.
|
void |
addValue(Comparable<?> v)
Adds 1 to the frequency count for v.
|
void |
addValue(int v)
Adds 1 to the frequency count for v.
|
void |
addValue(Integer v)
Deprecated.
to be removed in math 3.0
|
void |
addValue(long v)
Adds 1 to the frequency count for v.
|
void |
addValue(Object v)
Deprecated.
use
addValue(Comparable) instead |
void |
clear()
Clears the frequency table
|
boolean |
equals(Object obj) |
long |
getCount(char v)
Returns the number of values = v.
|
long |
getCount(Comparable<?> v)
Returns the number of values = v.
|
long |
getCount(int v)
Returns the number of values = v.
|
long |
getCount(long v)
Returns the number of values = v.
|
long |
getCount(Object v)
Deprecated.
replaced by
getCount(Comparable) as of 2.0 |
long |
getCumFreq(char v)
Returns the cumulative frequency of values less than or equal to v.
|
long |
getCumFreq(Comparable<?> v)
Returns the cumulative frequency of values less than or equal to v.
|
long |
getCumFreq(int v)
Returns the cumulative frequency of values less than or equal to v.
|
long |
getCumFreq(long v)
Returns the cumulative frequency of values less than or equal to v.
|
long |
getCumFreq(Object v)
Deprecated.
replaced by
getCumFreq(Comparable) as of 2.0 |
double |
getCumPct(char v)
Returns the cumulative percentage of values less than or equal to v
(as a proportion between 0 and 1).
|
double |
getCumPct(Comparable<?> v)
Returns the cumulative percentage of values less than or equal to v
(as a proportion between 0 and 1).
|
double |
getCumPct(int v)
Returns the cumulative percentage of values less than or equal to v
(as a proportion between 0 and 1).
|
double |
getCumPct(long v)
Returns the cumulative percentage of values less than or equal to v
(as a proportion between 0 and 1).
|
double |
getCumPct(Object v)
Deprecated.
replaced by
getCumPct(Comparable) as of 2.0 |
double |
getPct(char v)
Returns the percentage of values that are equal to v
(as a proportion between 0 and 1).
|
double |
getPct(Comparable<?> v)
Returns the percentage of values that are equal to v
(as a proportion between 0 and 1).
|
double |
getPct(int v)
Returns the percentage of values that are equal to v
(as a proportion between 0 and 1).
|
double |
getPct(long v)
Returns the percentage of values that are equal to v
(as a proportion between 0 and 1).
|
double |
getPct(Object v)
Deprecated.
replaced by
getPct(Comparable) as of 2.0 |
long |
getSumFreq()
Returns the sum of all frequencies.
|
int |
getUniqueCount()
Returns the number of values in the frequency table.
|
int |
hashCode() |
String |
toString()
Return a string representation of this frequency
distribution.
|
Iterator<Comparable<?>> |
valuesIterator()
Returns an Iterator over the set of values that have been added.
|
private static final long serialVersionUID
private final TreeMap<Comparable<?>,Long> freqTable
public Frequency()
public Frequency(Comparator<?> comparator)
comparator
- Comparator used to order valuespublic String toString()
@Deprecated public void addValue(Object v)
addValue(Comparable)
insteadIf other objects have already been added to this Frequency, v must be comparable to those that have already been added.
v
- the value to add.IllegalArgumentException
- if v
is not Comparable,
or is not comparable with previous entriespublic void addValue(Comparable<?> v)
If other objects have already been added to this Frequency, v must be comparable to those that have already been added.
v
- the value to add.IllegalArgumentException
- if v
is not comparable with previous entriespublic void addValue(int v)
v
- the value to add.@Deprecated public void addValue(Integer v)
v
- the value to add.public void addValue(long v)
v
- the value to add.public void addValue(char v)
v
- the value to add.public void clear()
public Iterator<Comparable<?>> valuesIterator()
If added values are integral (i.e., integers, longs, Integers, or Longs), they are converted to Longs when they are added, so the objects returned by the Iterator will in this case be Longs.
public long getSumFreq()
@Deprecated public long getCount(Object v)
getCount(Comparable)
as of 2.0v
- the value to lookup.public long getCount(Comparable<?> v)
v
- the value to lookup.public long getCount(int v)
v
- the value to lookup.public long getCount(long v)
v
- the value to lookup.public long getCount(char v)
v
- the value to lookup.public int getUniqueCount()
valuesIterator()
@Deprecated public double getPct(Object v)
getPct(Comparable)
as of 2.0
Returns Double.NaN
if no values have been added.
v
- the value to lookuppublic double getPct(Comparable<?> v)
Returns Double.NaN
if no values have been added.
v
- the value to lookuppublic double getPct(int v)
v
- the value to lookuppublic double getPct(long v)
v
- the value to lookuppublic double getPct(char v)
v
- the value to lookup@Deprecated public long getCumFreq(Object v)
getCumFreq(Comparable)
as of 2.0Returns 0 if v is not comparable to the values set.
v
- the value to lookup.public long getCumFreq(Comparable<?> v)
Returns 0 if v is not comparable to the values set.
v
- the value to lookup.public long getCumFreq(int v)
Returns 0 if v is not comparable to the values set.
v
- the value to lookuppublic long getCumFreq(long v)
Returns 0 if v is not comparable to the values set.
v
- the value to lookuppublic long getCumFreq(char v)
Returns 0 if v is not comparable to the values set.
v
- the value to lookup@Deprecated public double getCumPct(Object v)
getCumPct(Comparable)
as of 2.0
Returns Double.NaN
if no values have been added.
Returns 0 if at least one value has been added, but v is not comparable
to the values set.
v
- the value to lookuppublic double getCumPct(Comparable<?> v)
Returns Double.NaN
if no values have been added.
Returns 0 if at least one value has been added, but v is not comparable
to the values set.
v
- the value to lookuppublic double getCumPct(int v)
Returns 0 if v is not comparable to the values set.
v
- the value to lookuppublic double getCumPct(long v)
Returns 0 if v is not comparable to the values set.
v
- the value to lookuppublic double getCumPct(char v)
Returns 0 if v is not comparable to the values set.
v
- the value to lookupCopyright (c) 2003-2013 Apache Software Foundation