UnivariateEqualFrequencyHistogramEstimator (interruptible-weka 0.1.2 API)

java.lang.Object
- weka.estimators.UnivariateEqualFrequencyHistogramEstimator

All Implemented Interfaces:

java.io.Serializable, RevisionHandler, UnivariateDensityEstimator, UnivariateIntervalEstimator, UnivariateQuantileEstimator
```
public class UnivariateEqualFrequencyHistogramEstimator
extends java.lang.Object
implements UnivariateDensityEstimator, UnivariateIntervalEstimator, UnivariateQuantileEstimator, java.io.Serializable
```
Simple histogram density estimator. Uses equal-frequency histograms based on the specified number of bins (default: 10).

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`CONST` Constant for Gaussian density.
`protected double[]`	`m_Boundaries` The interval boundaries.
`protected double`	`m_Exponent` The exponent to use in computation of bandwidth (default: -0.25)
`protected double`	`m_MinWidth` The minimum allowed value of the kernel width (default: 1.0E-6)
`protected int`	`m_NumBins` The number of bins to use.
`protected int`	`m_NumIntervals` The number of intervals used to approximate prediction interval.
`protected double`	`m_SumOfWeights` The total sum of weights.
`protected java.util.TreeMap<java.lang.Double,java.lang.Double>`	`m_TM` The collection used to store the weighted values.
`protected boolean`	`m_UpdateWeightsOnly` Whether boundaries are updated or only weights.
`protected double`	`m_WeightedSum` The weighted sum of values
`protected double`	`m_WeightedSumSquared` The weighted sum of squared values
`protected double[]`	`m_Weights` The weight of each interval.
`protected double`	`m_Width` The current bandwidth (only computed when needed)

Constructor Summary

Constructors
Constructor and Description

UnivariateEqualFrequencyHistogramEstimator()

Constructors
Constructor and Description
`UnivariateEqualFrequencyHistogramEstimator()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addValue(double value, double weight)` Adds a value to the density estimator.
`int`	`getNumBins()` Gets the number of bins
`java.lang.String`	`getRevision()` Returns the revision string.
`boolean`	`getUpdateWeightsOnly()` Gets whether only weights should be udpated
`java.lang.String`	`globalInfo()` Returns a string describing the estimator.
`void`	`initializeStatistics()` Triggers construction of estimator based on current data and then initializes the statistics.
`double`	`logDensity(double value)` Returns the natural logarithm of the density estimate at the given point.
`static void`	`main(java.lang.String[] args)` Main method, used for testing this class.
`double[][]`	`predictIntervals(double conf)` Returns the interval for the given confidence value.
`double`	`predictQuantile(double percentage)` Returns the quantile for the given percentage.
`void`	`setNumBins(int numBins)` Sets the number of bins
`void`	`setUpdateWeightsOnly(boolean flag)` Sets whether only weights should be udpated.
`java.lang.String`	`toString()` Returns textual description of this estimator.
`protected void`	`updateBoundariesAndOrWeights()` Updates the boundaries if necessary.
`protected void`	`updateBoundariesAndWeights()` Updates the boundaries and weights.
`protected void`	`updateWeightsOnly()` Updates the weights only.

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

- Field Detail
  - m_TM
```
protected java.util.TreeMap<java.lang.Double,java.lang.Double> m_TM
```
    The collection used to store the weighted values.
  - m_Boundaries
```
protected double[] m_Boundaries
```
    The interval boundaries.
  - m_Weights
```
protected double[] m_Weights
```
    The weight of each interval.
  - m_WeightedSum
```
protected double m_WeightedSum
```
    The weighted sum of values
  - m_WeightedSumSquared
```
protected double m_WeightedSumSquared
```
    The weighted sum of squared values
  - m_SumOfWeights
```
protected double m_SumOfWeights
```
    The total sum of weights.
  - m_NumBins
```
protected int m_NumBins
```
    The number of bins to use.
  - m_Width
```
protected double m_Width
```
    The current bandwidth (only computed when needed)
  - m_Exponent
```
protected double m_Exponent
```
    The exponent to use in computation of bandwidth (default: -0.25)
  - m_MinWidth
```
protected double m_MinWidth
```
    The minimum allowed value of the kernel width (default: 1.0E-6)
  - CONST
```
public static final double CONST
```
    Constant for Gaussian density.
  - m_NumIntervals
```
protected int m_NumIntervals
```
    The number of intervals used to approximate prediction interval.
  - m_UpdateWeightsOnly
```
protected boolean m_UpdateWeightsOnly
```
    Whether boundaries are updated or only weights.
- Constructor Detail
  - UnivariateEqualFrequencyHistogramEstimator
```
public UnivariateEqualFrequencyHistogramEstimator()
```
- Method Detail
  - globalInfo
```
public java.lang.String globalInfo()
```
    Returns a string describing the estimator.
  - getNumBins
```
public int getNumBins()
```
    Gets the number of bins
    
    Returns:
    
    the number of bins.
  - setNumBins
```
public void setNumBins(int numBins)
```
    Sets the number of bins
    
    Parameters:
    
    numBins - the number of bins
  - initializeStatistics
```
public void initializeStatistics()
```
    Triggers construction of estimator based on current data and then initializes the statistics.
  - setUpdateWeightsOnly
```
public void setUpdateWeightsOnly(boolean flag)
```
    Sets whether only weights should be udpated.
  - getUpdateWeightsOnly
```
public boolean getUpdateWeightsOnly()
```
    Gets whether only weights should be udpated.*
  - addValue
```
public void addValue(double value,
                     double weight)
```
    Adds a value to the density estimator.
    
    Specified by:
    
    addValue in interface UnivariateDensityEstimator
    
    Specified by:
    
    addValue in interface UnivariateIntervalEstimator
    
    Specified by:
    
    addValue in interface UnivariateQuantileEstimator
    
    Parameters:
    
    value - the value to add
    
    weight - the weight of the value
  - updateBoundariesAndOrWeights
```
protected void updateBoundariesAndOrWeights()
```
    Updates the boundaries if necessary.
  - updateWeightsOnly
```
protected void updateWeightsOnly()
                          throws java.lang.IllegalArgumentException
```
    Updates the weights only.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - updateBoundariesAndWeights
```
protected void updateBoundariesAndWeights()
```
    Updates the boundaries and weights.
  - predictIntervals
```
public double[][] predictIntervals(double conf)
```
    Returns the interval for the given confidence value.
    
    Specified by:
    
    predictIntervals in interface UnivariateIntervalEstimator
    
    Parameters:
    
    conf - the confidence value in the interval [0, 1]
    
    Returns:
    
    the interval
  - predictQuantile
```
public double predictQuantile(double percentage)
```
    Returns the quantile for the given percentage.
    
    Specified by:
    
    predictQuantile in interface UnivariateQuantileEstimator
    
    Parameters:
    
    percentage - the percentage
    
    Returns:
    
    the quantile
  - logDensity
```
public double logDensity(double value)
```
    Returns the natural logarithm of the density estimate at the given point.
    
    Specified by:
    
    logDensity in interface UnivariateDensityEstimator
    
    Parameters:
    
    value - the value at which to evaluate
    
    Returns:
    
    the natural logarithm of the density estimate at the given value
  - getRevision
```
public java.lang.String getRevision()
```
    Returns the revision string.
    
    Specified by:
    
    getRevision in interface RevisionHandler
    
    Returns:
    
    the revision
  - toString
```
public java.lang.String toString()
```
    Returns textual description of this estimator.
    
    Overrides:
    
    toString in class java.lang.Object
  - main
```
public static void main(java.lang.String[] args)
```
    Main method, used for testing this class.

Class UnivariateEqualFrequencyHistogramEstimator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_TM

m_Boundaries

m_Weights

m_WeightedSum

m_WeightedSumSquared

m_SumOfWeights

m_NumBins

m_Width

m_Exponent

m_MinWidth

CONST

m_NumIntervals

m_UpdateWeightsOnly

Constructor Detail

UnivariateEqualFrequencyHistogramEstimator

Method Detail

globalInfo

getNumBins

setNumBins

initializeStatistics

setUpdateWeightsOnly

getUpdateWeightsOnly

addValue

updateBoundariesAndOrWeights

updateWeightsOnly

updateBoundariesAndWeights

predictIntervals

predictQuantile

logDensity

getRevision

toString

main