Histogram (BioCommons 3.0.4 API)

java.lang.Object
- pl.poznan.put.circular.Histogram

Direct Known Subclasses:

ImmutableHistogram
```
@Immutable
public abstract class Histogram
extends Object
```
A collection of angular observations put into bins of specified width.

Constructor Summary

Constructors
Constructor Description

Histogram()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected Collection<pl.poznan.put.circular.Histogram.Bin>`	`bins()`
`abstract double`	`binWidth()`
`protected void`	`check()`
`abstract Collection<Angle>`	`data()`
`Collection<Angle>`	`findBin(double radiansStart)`	Finds a bin which starts at a given point.
`double`	`largestBinSize()`	Finds the largest bin and calculate its relative size.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Histogram
```
public Histogram()
```
- Method Detail
  - data
```
@Parameter(order=1)
public abstract Collection<Angle> data()
```
    Returns:
    
    A collection of angular data.
  - binWidth
```
@Parameter(order=2)
public abstract double binWidth()
```
    Returns:
    
    The width of bin in range [0, pi).
  - largestBinSize
```
public final double largestBinSize()
```
    Finds the largest bin and calculate its relative size.
    
    Returns:
    
    Value in range [0; 1] describing relative size of the largest bin.
  - findBin
```
public final Collection<Angle> findBin(double radiansStart)
```
    Finds a bin which starts at a given point.
    
    Parameters:
    
    radiansStart - Value in radians which describes bin starting point (precision 1.0e-3).
    
    Returns:
    
    A collection of circular values in the found bin.
  - bins
```
@Lazy
protected Collection<pl.poznan.put.circular.Histogram.Bin> bins()
```
  - check
```
@Check
protected void check()
```