ProbabilityEstimator (Palmetto 0.1.4 API)

All Known Implementing Classes:

AbstractProbabilitySupplier, BooleanDocumentProbabilitySupplier, SpeedComparison.TimeMeasuringProbabilitySupplier, WindowBasedProbabilityEstimator
```
public interface ProbabilityEstimator
```
This interface defines the methods of a class that estimates the probabilities of a given word set.

Author:

m.roeder

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`FrequencyDeterminer`	`getFrequencyDeterminer()`	Returns the frequency determiner used by this estimator.
`String`	`getName()`	Returns the name of this probability estimator.
`SubsetProbabilities[]`	`getProbabilities(String[][] wordsets, SegmentationDefinition[] definitions)`	Estimates the probabilities for the given word sets and the given segmentations.
`void`	`setFrequencyDeterminer(FrequencyDeterminer determiner)`	Sets the frequency determiner that should be used by this estimator.
`void`	`setMinFrequency(int minFrequency)`	Sets the minimum frequency a word (or word set) must have to get a probability > 0.

- Method Detail
  - getProbabilities
```
SubsetProbabilities[] getProbabilities(String[][] wordsets,
                                       SegmentationDefinition[] definitions)
```
    Estimates the probabilities for the given word sets and the given segmentations.
    
    Parameters:
    
    wordsets - word sets for which the probabilities should be estimated
    
    definitions - definitions how the word sets should be separated
    
    Returns:
    
    the subset probabilities for the single word sets
  - getFrequencyDeterminer
```
FrequencyDeterminer getFrequencyDeterminer()
```
    Returns the frequency determiner used by this estimator.
    
    Returns:
    
    the frequency determiner used by this estimator
  - setFrequencyDeterminer
```
void setFrequencyDeterminer(FrequencyDeterminer determiner)
```
    Sets the frequency determiner that should be used by this estimator.
    
    Parameters:
    
    determiner - the frequency determiner used by this estimator
  - getName
```
String getName()
```
    Returns the name of this probability estimator.
    
    Returns:
    
    the name of this probability estimator
  - setMinFrequency
```
void setMinFrequency(int minFrequency)
```
    Sets the minimum frequency a word (or word set) must have to get a probability > 0.
    
    Parameters:
    
    minFrequency - the minimum frequency of a word