Apache Commons Math 3.6.1 · org.apache.commons.math3.stat.Frequency

Modifier and Type	Class and Description
private static class	Frequency.NaturalComparator< the type of the objects compared T extends Comparable<T>> A Comparator that compares comparable objects using the natural order.

Modifier and Type	Field and Description
private final SortedMap<Comparable<?>, Long>	freqTable underlying collection
private static final long	serialVersionUID Serializable version identifier

Access	Constructor and Description
public	Frequency() Default constructor.
public	Frequency(Comparator<?> Comparator used to order values comparator) Constructor allowing values Comparator to be specified.

Method Summary

Modifier and Type	Method and Description
public void	addValue(Comparable<?> the value to add. v) Adds 1 to the frequency count for v. If other objects have already been added to this Frequency, v must be comparable to those that have already been added.
public void	addValue(int the value to add. v) Adds 1 to the frequency count for v.
public void	addValue(long the value to add. v) Adds 1 to the frequency count for v.
public void	addValue(char the value to add. v) Adds 1 to the frequency count for v.
public void	clear() Clears the frequency table
public Iterator<Map.Entry<Comparable<?>, Long>>	Returns: entry set Iterator entrySetIterator() Return an Iterator over the set of keys and values that have been added.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public long	Returns: the frequency of v. getCount(Comparable<?> the value to lookup. v) Returns the number of values equal to v. Returns 0 if the value is not comparable.
public long	Returns: the frequency of v. getCount(int the value to lookup. v) Returns the number of values equal to v.
public long	Returns: the frequency of v. getCount(long the value to lookup. v) Returns the number of values equal to v.
public long	Returns: the frequency of v. getCount(char the value to lookup. v) Returns the number of values equal to v.
public long	Returns: the proportion of values equal to v getCumFreq(Comparable<?> the value to lookup. v) Returns the cumulative frequency of values less than or equal to v. Returns 0 if v is not comparable to the values set.
public long	Returns: the proportion of values equal to v getCumFreq(int the value to lookup v) Returns the cumulative frequency of values less than or equal to v. Returns 0 if v is not comparable to the values set.
public long	Returns: the proportion of values equal to v getCumFreq(long the value to lookup v) Returns the cumulative frequency of values less than or equal to v. Returns 0 if v is not comparable to the values set.
public long	Returns: the proportion of values equal to v getCumFreq(char the value to lookup v) Returns the cumulative frequency of values less than or equal to v. Returns 0 if v is not comparable to the values set.
public double	Returns: the proportion of values less than or equal to v getCumPct(Comparable<?> the value to lookup v) Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1).
public double	Returns: the proportion of values less than or equal to v getCumPct(int the value to lookup v) Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1).
public double	Returns: the proportion of values less than or equal to v getCumPct(long the value to lookup v) Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1).
public double	Returns: the proportion of values less than or equal to v getCumPct(char the value to lookup v) Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1).
public List<Comparable<?>>	Returns: a list containing the value(s) which appear most often. getMode() Returns the mode value(s) in comparator order.
public double	Returns: the proportion of values equal to v getPct(Comparable<?> the value to lookup v) Returns the percentage of values that are equal to v (as a proportion between 0 and 1).
public double	Returns: the proportion of values equal to v getPct(int the value to lookup v) Returns the percentage of values that are equal to v (as a proportion between 0 and 1).
public double	Returns: the proportion of values equal to v getPct(long the value to lookup v) Returns the percentage of values that are equal to v (as a proportion between 0 and 1).
public double	Returns: the proportion of values equal to v getPct(char the value to lookup v) Returns the percentage of values that are equal to v (as a proportion between 0 and 1).
public long	Returns: the total frequency count. getSumFreq() Returns the sum of all frequencies.
public int	Returns: the number of unique values that have been added to the frequency table. getUniqueCount() Returns the number of values in the frequency table.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	incrementValue(Comparable<?> the value to add. v, long the amount by which the value should be incremented increment) Increments the frequency count for v. If other objects have already been added to this Frequency, v must be comparable to those that have already been added.
public void	incrementValue(int the value to add. v, long the amount by which the value should be incremented increment) Increments the frequency count for v. If other objects have already been added to this Frequency, v must be comparable to those that have already been added.
public void	incrementValue(long the value to add. v, long the amount by which the value should be incremented increment) Increments the frequency count for v. If other objects have already been added to this Frequency, v must be comparable to those that have already been added.
public void	incrementValue(char the value to add. v, long the amount by which the value should be incremented increment) Increments the frequency count for v. If other objects have already been added to this Frequency, v must be comparable to those that have already been added.
public void	merge(final Frequency the other `Frequency` object to be merged other) Merge another Frequency object's counts into this instance.
public void	merge(final Collection<Frequency> the other `Frequency` objects to be merged others) Merge a `Collection` of `Frequency` objects into this instance.
public String	Returns: a string representation. toString() Overrides java.lang.Object.toString. Return a string representation of this frequency distribution.
public Iterator<Comparable<?>>	Returns: values Iterator valuesIterator() Returns an Iterator over the set of values that have been added.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

freqTable	back to summary
private final SortedMap<Comparable<?>, Long> freqTable underlying collection

serialVersionUID	back to summary
private static final long serialVersionUID Serializable version identifier

Frequency	back to summary
public Frequency() Default constructor.

Frequency	back to summary
public Frequency(Comparator<?> comparator) Constructor allowing values Comparator to be specified. Parameters comparator:Comparator<?> Comparator used to order values Annotations @SuppressWarnings:unchecked

Method Detail

addValue back to summary

addValue	back to summary
public void addValue(Comparable<?> v) throws MathIllegalArgumentException Adds 1 to the frequency count for v. If other objects have already been added to this Frequency, v must be comparable to those that have already been added. Parameters v:Comparable<?> the value to add. Exceptions MathIllegalArgumentException: if `v` is not comparable with previous entries

public void addValue(Comparable<?> v) throws MathIllegalArgumentException

Adds 1 to the frequency count for v.

If other objects have already been added to this Frequency, v must be comparable to those that have already been added.

Parameters

v:Comparable<?>: the value to add.

Exceptions

MathIllegalArgumentException:: if v is not comparable with previous entries

addValue	back to summary
public void addValue(int v) throws MathIllegalArgumentException Adds 1 to the frequency count for v. Parameters v:int the value to add. Exceptions MathIllegalArgumentException: if the table contains entries not comparable to Long

addValue

back to summary

public void addValue(int v) throws MathIllegalArgumentException

Adds 1 to the frequency count for v.

Parameters

v:int: the value to add.

Exceptions

MathIllegalArgumentException:: if the table contains entries not comparable to Long

addValue	back to summary
public void addValue(long v) throws MathIllegalArgumentException Adds 1 to the frequency count for v. Parameters v:long the value to add. Exceptions MathIllegalArgumentException: if the table contains entries not comparable to Long

addValue

back to summary

public void addValue(long v) throws MathIllegalArgumentException

Adds 1 to the frequency count for v.

Parameters

v:long: the value to add.

Exceptions

MathIllegalArgumentException:: if the table contains entries not comparable to Long

addValue	back to summary
public void addValue(char v) throws MathIllegalArgumentException Adds 1 to the frequency count for v. Parameters v:char the value to add. Exceptions MathIllegalArgumentException: if the table contains entries not comparable to Char

addValue

back to summary

public void addValue(char v) throws MathIllegalArgumentException

Adds 1 to the frequency count for v.

Parameters

v:char: the value to add.

Exceptions

MathIllegalArgumentException:: if the table contains entries not comparable to Char

clear	back to summary
public void clear() Clears the frequency table

entrySetIterator	back to summary
public Iterator<Map.Entry<Comparable<?>, Long>> entrySetIterator() Return an Iterator over the set of keys and values that have been added. Using the entry set to iterate is more efficient in the case where you need to access respective counts as well as values, since it doesn't require a "get" for every key...the value is provided in the Map.Entry. If added values are integral (i.e., integers, longs, Integers, or Longs), they are converted to Longs when they are added, so the values of the map entries returned by the Iterator will in this case be Longs. Returns:Iterator<Map.Entry<Comparable<?>, Long>> entry set Iterator Since 3.1

entrySetIterator

back to summary

public Iterator<Map.Entry<Comparable<?>, Long>> entrySetIterator()

Return an Iterator over the set of keys and values that have been added. Using the entry set to iterate is more efficient in the case where you need to access respective counts as well as values, since it doesn't require a "get" for every key...the value is provided in the Map.Entry.

If added values are integral (i.e., integers, longs, Integers, or Longs), they are converted to Longs when they are added, so the values of the map entries returned by the Iterator will in this case be Longs.

Returns:Iterator<Map.Entry<Comparable<?>, Long>>: entry set Iterator
Since: 3.1

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getCount	back to summary
public long getCount(Comparable<?> v) Returns the number of values equal to v. Returns 0 if the value is not comparable. Parameters v:Comparable<?> the value to lookup. Returns:long the frequency of v.

getCount

back to summary

public long getCount(Comparable<?> v)

Returns the number of values equal to v. Returns 0 if the value is not comparable.

Parameters

v:Comparable<?>: the value to lookup.

Returns:long

the frequency of v.

getCount	back to summary
public long getCount(int v) Returns the number of values equal to v. Parameters v:int the value to lookup. Returns:long the frequency of v.

getCount

back to summary

public long getCount(int v)

Returns the number of values equal to v.

Parameters

v:int: the value to lookup.

Returns:long

the frequency of v.

getCount	back to summary
public long getCount(long v) Returns the number of values equal to v. Parameters v:long the value to lookup. Returns:long the frequency of v.

getCount

back to summary

public long getCount(long v)

Returns the number of values equal to v.

Parameters

v:long: the value to lookup.

Returns:long

the frequency of v.

getCount	back to summary
public long getCount(char v) Returns the number of values equal to v. Parameters v:char the value to lookup. Returns:long the frequency of v.

getCount

back to summary

public long getCount(char v)

Returns the number of values equal to v.

Parameters

v:char: the value to lookup.

Returns:long

the frequency of v.

getCumFreq	back to summary
public long getCumFreq(Comparable<?> v) Returns the cumulative frequency of values less than or equal to v. Returns 0 if v is not comparable to the values set. Parameters v:Comparable<?> the value to lookup. Returns:long the proportion of values equal to v Annotations @SuppressWarnings:rawtypes, unchecked

getCumFreq

back to summary

public long getCumFreq(Comparable<?> v)

Returns the cumulative frequency of values less than or equal to v.

Returns 0 if v is not comparable to the values set.

Parameters

v:Comparable<?>: the value to lookup.

Returns:long

the proportion of values equal to v

Annotations

@SuppressWarnings:rawtypes, unchecked

getCumFreq	back to summary
public long getCumFreq(int v) Returns the cumulative frequency of values less than or equal to v. Returns 0 if v is not comparable to the values set. Parameters v:int the value to lookup Returns:long the proportion of values equal to v

getCumFreq

back to summary

public long getCumFreq(int v)

Returns the cumulative frequency of values less than or equal to v.

Returns 0 if v is not comparable to the values set.

Parameters

v:int: the value to lookup

Returns:long

the proportion of values equal to v

getCumFreq	back to summary
public long getCumFreq(long v) Returns the cumulative frequency of values less than or equal to v. Returns 0 if v is not comparable to the values set. Parameters v:long the value to lookup Returns:long the proportion of values equal to v

getCumFreq

back to summary

public long getCumFreq(long v)

Returns the cumulative frequency of values less than or equal to v.

Returns 0 if v is not comparable to the values set.

Parameters

v:long: the value to lookup

Returns:long

the proportion of values equal to v

getCumFreq	back to summary
public long getCumFreq(char v) Returns the cumulative frequency of values less than or equal to v. Returns 0 if v is not comparable to the values set. Parameters v:char the value to lookup Returns:long the proportion of values equal to v

getCumFreq

back to summary

public long getCumFreq(char v)

Returns the cumulative frequency of values less than or equal to v.

Returns 0 if v is not comparable to the values set.

Parameters

v:char: the value to lookup

Returns:long

the proportion of values equal to v

getCumPct back to summary

getCumPct	back to summary
public double getCumPct(Comparable<?> v) Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1). 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. Parameters v:Comparable<?> the value to lookup Returns:double the proportion of values less than or equal to v

public double getCumPct(Comparable<?> v)

Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1).

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.

Parameters

v:Comparable<?>: the value to lookup

Returns:double

the proportion of values less than or equal to v

getCumPct	back to summary
public double getCumPct(int v) Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1). Returns 0 if v is not comparable to the values set. Parameters v:int the value to lookup Returns:double the proportion of values less than or equal to v

getCumPct

back to summary

public double getCumPct(int v)

Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1).

Returns 0 if v is not comparable to the values set.

Parameters

v:int: the value to lookup

Returns:double

the proportion of values less than or equal to v

getCumPct	back to summary
public double getCumPct(long v) Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1). Returns 0 if v is not comparable to the values set. Parameters v:long the value to lookup Returns:double the proportion of values less than or equal to v

getCumPct

back to summary

public double getCumPct(long v)

Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1).

Returns 0 if v is not comparable to the values set.

Parameters

v:long: the value to lookup

Returns:double

the proportion of values less than or equal to v

getCumPct	back to summary
public double getCumPct(char v) Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1). Returns 0 if v is not comparable to the values set. Parameters v:char the value to lookup Returns:double the proportion of values less than or equal to v

getCumPct

back to summary

public double getCumPct(char v)

Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1).

Returns 0 if v is not comparable to the values set.

Parameters

v:char: the value to lookup

Returns:double

the proportion of values less than or equal to v

getMode	back to summary
public List<Comparable<?>> getMode() Returns the mode value(s) in comparator order. Returns:List<Comparable<?>> a list containing the value(s) which appear most often. Since 3.3

getMode

back to summary

public List<Comparable<?>> getMode()

Returns the mode value(s) in comparator order.

Returns:List<Comparable<?>>: a list containing the value(s) which appear most often.
Since: 3.3

getPct back to summary

getPct	back to summary
public double getPct(Comparable<?> v) Returns the percentage of values that are equal to v (as a proportion between 0 and 1). 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. Parameters v:Comparable<?> the value to lookup Returns:double the proportion of values equal to v

public double getPct(Comparable<?> v)

Returns the percentage of values that are equal to v (as a proportion between 0 and 1).

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.

Parameters

v:Comparable<?>: the value to lookup

Returns:double

the proportion of values equal to v

getPct	back to summary
public double getPct(int v) Returns the percentage of values that are equal to v (as a proportion between 0 and 1). Parameters v:int the value to lookup Returns:double the proportion of values equal to v

getPct

back to summary

public double getPct(int v)

Returns the percentage of values that are equal to v (as a proportion between 0 and 1).

Parameters

v:int: the value to lookup

Returns:double

the proportion of values equal to v

getPct	back to summary
public double getPct(long v) Returns the percentage of values that are equal to v (as a proportion between 0 and 1). Parameters v:long the value to lookup Returns:double the proportion of values equal to v

getPct

back to summary

public double getPct(long v)

Returns the percentage of values that are equal to v (as a proportion between 0 and 1).

Parameters

v:long: the value to lookup

Returns:double

the proportion of values equal to v

getPct	back to summary
public double getPct(char v) Returns the percentage of values that are equal to v (as a proportion between 0 and 1). Parameters v:char the value to lookup Returns:double the proportion of values equal to v

getPct

back to summary

public double getPct(char v)

Returns the percentage of values that are equal to v (as a proportion between 0 and 1).

Parameters

v:char: the value to lookup

Returns:double

the proportion of values equal to v

getSumFreq	back to summary
public long getSumFreq() Returns the sum of all frequencies. Returns:long the total frequency count.

getSumFreq

back to summary

public long getSumFreq()

Returns the sum of all frequencies.

Returns:long: the total frequency count.

getUniqueCount back to summary

getUniqueCount	back to summary
public int getUniqueCount() Returns the number of values in the frequency table. Returns:int the number of unique values that have been added to the frequency table. See Also `valuesIterator()`

public int getUniqueCount()

Returns the number of values in the frequency table.

Returns:int: the number of unique values that have been added to the frequency table.
See Also: valuesIterator()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

incrementValue back to summary

incrementValue	back to summary
public void incrementValue(Comparable<?> v, long increment) throws MathIllegalArgumentException Increments the frequency count for v. If other objects have already been added to this Frequency, v must be comparable to those that have already been added. Parameters v:Comparable<?> the value to add. increment:long the amount by which the value should be incremented Exceptions MathIllegalArgumentException: if `v` is not comparable with previous entries Since 3.1

public void incrementValue(Comparable<?> v, long increment) throws MathIllegalArgumentException

Increments the frequency count for v.

If other objects have already been added to this Frequency, v must be comparable to those that have already been added.

Parameters

v:Comparable<?>: the value to add.
increment:long: the amount by which the value should be incremented

Exceptions

MathIllegalArgumentException:: if v is not comparable with previous entries

Since

3.1

incrementValue	back to summary
public void incrementValue(int v, long increment) throws MathIllegalArgumentException Increments the frequency count for v. If other objects have already been added to this Frequency, v must be comparable to those that have already been added. Parameters v:int the value to add. increment:long the amount by which the value should be incremented Exceptions MathIllegalArgumentException: if the table contains entries not comparable to Long Since 3.3

incrementValue

back to summary

public void incrementValue(int v, long increment) throws MathIllegalArgumentException

Increments the frequency count for v.

If other objects have already been added to this Frequency, v must be comparable to those that have already been added.

Parameters

v:int: the value to add.
increment:long: the amount by which the value should be incremented

Exceptions

MathIllegalArgumentException:: if the table contains entries not comparable to Long

Since

3.3

incrementValue	back to summary
public void incrementValue(long v, long increment) throws MathIllegalArgumentException Increments the frequency count for v. If other objects have already been added to this Frequency, v must be comparable to those that have already been added. Parameters v:long the value to add. increment:long the amount by which the value should be incremented Exceptions MathIllegalArgumentException: if the table contains entries not comparable to Long Since 3.3

incrementValue

back to summary

public void incrementValue(long v, long increment) throws MathIllegalArgumentException

Increments the frequency count for v.

If other objects have already been added to this Frequency, v must be comparable to those that have already been added.

Parameters

v:long: the value to add.
increment:long: the amount by which the value should be incremented

Exceptions

MathIllegalArgumentException:: if the table contains entries not comparable to Long

Since

3.3

incrementValue	back to summary
public void incrementValue(char v, long increment) throws MathIllegalArgumentException Increments the frequency count for v. If other objects have already been added to this Frequency, v must be comparable to those that have already been added. Parameters v:char the value to add. increment:long the amount by which the value should be incremented Exceptions MathIllegalArgumentException: if the table contains entries not comparable to Char Since 3.3

incrementValue

back to summary

public void incrementValue(char v, long increment) throws MathIllegalArgumentException

Increments the frequency count for v.

If other objects have already been added to this Frequency, v must be comparable to those that have already been added.

Parameters

v:char: the value to add.
increment:long: the amount by which the value should be incremented

Exceptions

MathIllegalArgumentException:: if the table contains entries not comparable to Char

Since

3.3

merge back to summary

merge	back to summary
public void merge(final Frequency other) throws NullArgumentException Merge another Frequency object's counts into this instance. This Frequency's counts will be incremented (or set when not already set) by the counts represented by other. Parameters other:Frequency the other `Frequency` object to be merged Exceptions NullArgumentException: if `other` is null Since 3.1

public void merge(final Frequency other) throws NullArgumentException

Merge another Frequency object's counts into this instance. This Frequency's counts will be incremented (or set when not already set) by the counts represented by other.

Parameters

other:Frequency: the other Frequency object to be merged

Exceptions

NullArgumentException:: if other is null

Since

3.1

merge back to summary

merge	back to summary
public void merge(final Collection<Frequency> others) throws NullArgumentException Merge a `Collection` of `Frequency` objects into this instance. This Frequency's counts will be incremented (or set when not already set) by the counts represented by each of the others. Parameters others:Collection<Frequency> the other `Frequency` objects to be merged Exceptions NullArgumentException: if the collection is null Since 3.1

public void merge(final Collection<Frequency> others) throws NullArgumentException

Merge a Collection of Frequency objects into this instance. This Frequency's counts will be incremented (or set when not already set) by the counts represented by each of the others.

Parameters

others:Collection<Frequency>: the other Frequency objects to be merged

Exceptions

NullArgumentException:: if the collection is null

Since

3.1

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return a string representation of this frequency distribution. Returns:String a string representation. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Return a string representation of this frequency distribution.

Returns:String

a string representation.

Annotations

@Override

valuesIterator	back to summary
public Iterator<Comparable<?>> valuesIterator() Returns an Iterator over the set of values that have been added. 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. Returns:Iterator<Comparable<?>> values Iterator

valuesIterator

back to summary

public Iterator<Comparable<?>> valuesIterator()

Returns an Iterator over the set of values that have been added.

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.

Returns:Iterator<Comparable<?>>: values Iterator

public Class Frequency

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Frequency.NaturalComparator<T extends Comparable<T>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail