Counter (S-Space Package 2.0.1 API)

All Superinterfaces:

Iterable<Map.Entry<T,Integer>>

All Known Implementing Classes:

IndexedCounter, IsomorphicGraphCounter, ObjectCounter, PairCounter, TypedIsomorphicGraphCounter
```
public interface Counter<T>
extends Iterable<Map.Entry<T,Integer>>
```
A utility for counting unique instance of an object.
This class supports iterating over the set of instances being counted as well as the instances and counts together. All collections views that are returned are unmodifiable and will throw an exception if a mutating method is called.
This class is not thread-safe

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(Counter<? extends T> counter)` Adds the counts from the provided `Counter` to the current counts, adding new elements as needed.
`int`	`count(T obj)` Counts the object, increasing its total count by 1.
`int`	`count(T obj, int count)` Counts the object, increasing its total count by the specified positive amount.
`void`	`countAll(Collection<? extends T> c)` Counts all the elements in the collection.
`boolean`	`equals(Object o)`
`int`	`getCount(T obj)` Returns the number of times the specified object has been seen by this counter.
`double`	`getFrequency(T obj)` Returns the frequency of this object relative to the counts of all other objects.
`int`	`hashCode()`
`Set<T>`	`items()` Returns a view of the items currently being counted.
`Iterator<Map.Entry<T,Integer>>`	`iterator()` Returns an interator over the elements that have been counted thusfar and their respective counts.
`T`	`max()` Returns the element that currently has the largest count.
`T`	`min()` Returns the element that currently has the smallest count.
`void`	`reset()` Resets the counts for all objects.
`int`	`size()` Returns the number of unique instances that are currently being counted.
`int`	`sum()` Returns the total number of instances that have been counted.

- Method Detail
  - add
```
void add(Counter<? extends T> counter)
```
    Adds the counts from the provided Counter to the current counts, adding new elements as needed.
  - count
```
int count(T obj)
```
    Counts the object, increasing its total count by 1.
  - count
```
int count(T obj,
        int count)
```
    Counts the object, increasing its total count by the specified positive amount.
    
    Parameters:
    count - a positive value for the number of times the object occurred
    
    Returns:
    the current count for the counted object
    
    Throws:
    
    IllegalArgumentException - if count is not a positive value.
  - countAll
```
void countAll(Collection<? extends T> c)
```
    Counts all the elements in the collection.
    
    Parameters:
    c - a collection of elements to count
  - equals
```
boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getCount
```
int getCount(T obj)
```
    Returns the number of times the specified object has been seen by this counter.
  - getFrequency
```
double getFrequency(T obj)
```
    Returns the frequency of this object relative to the counts of all other objects. This value may also be interpreted as the probability of the instance of obj being seen in the items that have been counted.
  - hashCode
```
int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - items
```
Set<T> items()
```
    Returns a view of the items currently being counted. The returned view is read-only; any attempts to modify this view will throw an UnsupportedOperationException.
  - iterator
```
Iterator<Map.Entry<T,Integer>> iterator()
```
    Returns an interator over the elements that have been counted thusfar and their respective counts.
    
    Specified by:
    
    iterator in interface Iterable<Map.Entry<T,Integer>>
  - max
```
T max()
```
    Returns the element that currently has the largest count. If no objects have been counted, null is returned. Ties in counts are arbitrarily broken.
  - min
```
T min()
```
    Returns the element that currently has the smallest count. If no objects have been counted, null is returned. Ties in counts are arbitrarily broken.
  - reset
```
void reset()
```
    Resets the counts for all objects. The size of items() will be 0 after this call.
  - size
```
int size()
```
    Returns the number of unique instances that are currently being counted.
  - sum
```
int sum()
```
    Returns the total number of instances that have been counted.

Interface Counter<T>

Method Summary

Method Detail

add

count

count

countAll

equals

getCount

getFrequency

hashCode

items

iterator

max

min

reset

size

sum