All Implemented Interfaces:

kotlin.collections.Collection , kotlin.collections.Iterable , kotlin.collections.MutableCollection , kotlin.collections.MutableIterable
```
public final class Frequency<T extends Comparable<T>>
 implements Collection<T>
                    
```
Maintains a frequency distribution.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Integer`	`size`
`private final Integer`	`totalFrequency`
`private final Multiset.Entry<T>`	`mostEntry`
`private final Multiset.Entry<T>`	`leastEntry`
`private final T`	`mode`
`private final List<T>`	`modes`
`private final Double`	`modePercentage`
`private final String`	`name`

Constructor Summary

Constructors
Constructor	Description
`Frequency(String name)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Integer`	`getSize()`
`final Integer`	`getTotalFrequency()`
`final Multiset.Entry<T>`	`getMostEntry()`
`final Multiset.Entry<T>`	`getLeastEntry()`
`final T`	`getMode()`
`final List<T>`	`getModes()`
`final Double`	`getModePercentage()`
`final String`	`getName()`
`Boolean`	`add(T element)`
`Boolean`	`remove(T element)`
`Boolean`	`containsAll(Collection<T> elements)`
`Boolean`	`addAll(Collection<T> elements)`
`final Unit`	`addAll(Array<T> elements)`
`Boolean`	`removeAll(Collection<T> elements)`
`Boolean`	`retainAll(Collection<T> elements)`
`Unit`	`clear()`
`Boolean`	`isEmpty()`
`Boolean`	`contains(T element)`
`final Integer`	`count(T element)`
`final Set<Multiset.Entry<T>>`	`entrySet()`
`final Set<T>`	`elementSet()`
`Iterator<T>`	`iterator()`
`final Map<T, Integer>`	`ordinalMap()`	The ordinal for each element in the element set.
`final Double`	`percentageOf(T v)`	Returns the percentage of values that are equal to v (as a proportion between 0 and 1).
`final Double`	`cumulativePercentageOf(T v)`	Returns the cumulative percentage of values less than or equal to v (as a proportion between 0 and 1).
`final Integer`	`cumulativeFrequencyOf(T v)`	Returns the cumulative frequency of values less than or equal to v.
`final Integer`	`trimEnd(Double freqThreshold)`	Remove elements that are more than n, where n = freqThreshold if freqThreshold 1 or n = freqThreshold * size if freqThreshold< 1
`final Integer`	`trimStart(Double freqThreshold)`	Remove elements that are more than n, where n = freqThreshold if freqThreshold 1 or n = freqThreshold * size if freqThreshold< 1
`final Unit`	`exportTo(Path path)`
`final String`	`toPString(String prefix, String postfix, String delimiter)`
`final String`	`toPString(String prefix, String postfix)`
`final String`	`toPString(String prefix)`
`final String`	`toPString()`
`final String`	`toReport(String prefix, String postfix)`
`final String`	`toReport(String prefix)`
`final String`	`toReport()`
`String`	`toString()`	Return a string representation of this frequency distribution.
`Integer`	`hashCode()`
`Boolean`	`equals(Object other)`

Methods inherited from class kotlin.collections.Iterable
forEach
Methods inherited from class kotlin.collections.Collection
parallelStream, spliterator, stream, toArray
Methods inherited from class kotlin.collections.MutableCollection
removeIf
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Frequency
```
Frequency(String name)
```
- Method Detail
  - getSize
```
 Integer getSize()
```
  - getTotalFrequency
```
 final Integer getTotalFrequency()
```
  - getMostEntry
```
 final Multiset.Entry<T> getMostEntry()
```
  - getLeastEntry
```
 final Multiset.Entry<T> getLeastEntry()
```
  - getMode
```
 final T getMode()
```
  - getModes
```
 final List<T> getModes()
```
  - getModePercentage
```
 final Double getModePercentage()
```
  - getName
```
 final String getName()
```
  - add
```
 Boolean add(T element)
```
  - remove
```
 Boolean remove(T element)
```
  - containsAll
```
 Boolean containsAll(Collection<T> elements)
```
  - addAll
```
 Boolean addAll(Collection<T> elements)
```
  - addAll
```
 final Unit addAll(Array<T> elements)
```
  - removeAll
```
 Boolean removeAll(Collection<T> elements)
```
  - retainAll
```
 Boolean retainAll(Collection<T> elements)
```
  - clear
```
 Unit clear()
```
  - isEmpty
```
 Boolean isEmpty()
```
  - contains
```
 Boolean contains(T element)
```
  - count
```
 final Integer count(T element)
```
  - entrySet
```
 final Set<Multiset.Entry<T>> entrySet()
```
  - elementSet
```
 final Set<T> elementSet()
```
  - iterator
```
 Iterator<T> iterator()
```
  - ordinalMap
```
 final Map<T, Integer> ordinalMap()
```
    The ordinal for each element in the element set.
  - percentageOf
```
 final Double percentageOf(T 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.
    
    Parameters:
    
    v - the value to lookup
    
    Returns:
    
    the proportion of values equal to v
  - cumulativePercentageOf
```
 final Double cumulativePercentageOf(T 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 - the value to lookup
    
    Returns:
    
    the proportion of values less than or equal to v
  - cumulativeFrequencyOf
```
 final Integer cumulativeFrequencyOf(T v)
```
    Returns the cumulative frequency of values less than or equal to v.
    Cumulative frequency analysis is the analysis of the frequency of occurrence of values of a phenomenon less than a reference value. The phenomenon may be time- or space-dependent. Cumulative frequency is also called frequency of non-exceedance.
    
    Parameters:
    
    v - the value to lookup.
    
    Returns:
    
    the proportion of values equal to v
  - trimEnd
```
 final Integer trimEnd(Double freqThreshold)
```
    Remove elements that are more than n, where n = freqThreshold if freqThreshold 1 or n = freqThreshold * size if freqThreshold< 1
  - trimStart
```
 final Integer trimStart(Double freqThreshold)
```
    Remove elements that are more than n, where n = freqThreshold if freqThreshold 1 or n = freqThreshold * size if freqThreshold< 1
  - exportTo
```
 final Unit exportTo(Path path)
```
  - toPString
```
@JvmOverloads() final String toPString(String prefix, String postfix, String delimiter)
```
  - toPString
```
@JvmOverloads() final String toPString(String prefix, String postfix)
```
  - toPString
```
@JvmOverloads() final String toPString(String prefix)
```
  - toPString
```
@JvmOverloads() final String toPString()
```
  - toReport
```
@JvmOverloads() final String toReport(String prefix, String postfix)
```
  - toReport
```
@JvmOverloads() final String toReport(String prefix)
```
  - toReport
```
@JvmOverloads() final String toReport()
```
  - toString
```
 String toString()
```
    Return a string representation of this frequency distribution.
    
    Returns:
    
    a string representation.
  - hashCode
```
 Integer hashCode()
```
  - equals
```
 Boolean equals(Object other)
```

Class Frequency

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class kotlin.collections.Iterable

Methods inherited from class kotlin.collections.Collection

Methods inherited from class kotlin.collections.MutableCollection

Methods inherited from class java.lang.Object

Constructor Detail

Frequency

Method Detail

getSize

getTotalFrequency

getMostEntry

getLeastEntry

getMode

getModes

getModePercentage

getName

add

remove

containsAll

addAll

addAll

removeAll

retainAll

clear

isEmpty

contains

count

entrySet

elementSet

iterator

ordinalMap

percentageOf

cumulativePercentageOf

cumulativeFrequencyOf

trimEnd

trimStart

exportTo

toPString

toPString

toPString

toPString

toReport

toReport

toReport

toString

hashCode

equals