DiscreteProbabilityBuffer (VirtualDataSet API)

java.lang.Object
- io.virtdata.stathelpers.DiscreteProbabilityBuffer

All Implemented Interfaces:: java.lang.Iterable<DiscreteProbabilityBuffer.Entry>

public class DiscreteProbabilityBuffer
extends java.lang.Object
implements java.lang.Iterable<DiscreteProbabilityBuffer.Entry>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DiscreteProbabilityBuffer.Entry

Field Summary

Fields
Modifier and Type Field Description

static int RECORD_LEN

Constructor Summary

Constructors
Constructor Description

DiscreteProbabilityBuffer(int entries)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DiscreteProbabilityBuffer`	`add(int i, double probability)`
`double`	`getCumulativeProbability()`
`java.util.Iterator<DiscreteProbabilityBuffer.Entry>`	`iterator()`
`void`	`normalize()`
`void`	`normalize(double phi)`	Normalize the dataset, but only if the cumulative probability is not close to the unit probability of 1.0D, within some phi threshold.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - RECORD_LEN
```
public static int RECORD_LEN
```
- Constructor Detail
  - DiscreteProbabilityBuffer
```
public DiscreteProbabilityBuffer(int entries)
```
- Method Detail
  - add
```
public DiscreteProbabilityBuffer add(int i,
                                     double probability)
```
  - normalize
```
public void normalize(double phi)
```
    Normalize the dataset, but only if the cumulative probability is not close to the unit probability of 1.0D, within some phi threshold. In either case, mark the dataset as normalized.
    
    Parameters:
    
    phi - A double value, preferably very small, like 0.000000001D
  - normalize
```
public void normalize()
```
  - iterator
```
public java.util.Iterator<DiscreteProbabilityBuffer.Entry> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<DiscreteProbabilityBuffer.Entry>
  - getCumulativeProbability
```
public double getCumulativeProbability()
```