Package weka.estimators
Class NormalEstimator
java.lang.Object
weka.estimators.Estimator
weka.estimators.NormalEstimator
- All Implemented Interfaces:
Serializable
,Cloneable
,Aggregateable<NormalEstimator>
,CapabilitiesHandler
,CapabilitiesIgnorer
,OptionHandler
,RevisionHandler
,IncrementalEstimator
public class NormalEstimator
extends Estimator
implements IncrementalEstimator, Aggregateable<NormalEstimator>
Simple probability estimator that places a single normal distribution over
the observed values.
- Version:
- $Revision: 15521 $
- Author:
- Len Trigg (trigg@cs.waikato.ac.nz)
- See Also:
-
Constructor Summary
ConstructorDescriptionNo-arg constructor needed to make WEKA's forName() work.NormalEstimator
(double precision) Constructor that takes a precision argument. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addValue
(double data, double weight) Add a new data value to the current estimator.aggregate
(NormalEstimator toAggregate) Aggregate an object with this onevoid
Call to complete the aggregation process.Returns default capabilities of the classifier.double
getMean()
Return the value of the mean of this normal estimator.double
Return the value of the precision of this normal estimator.double
getProbability
(double data) Get a probability estimate for a valueReturns the revision string.double
Return the value of the standard deviation of this normal estimator.double
Return the sum of the weights for this normal estimator.static void
Main method for testing this class.static void
toString()
Display a representation of this estimatorMethods inherited from class weka.estimators.Estimator
addValues, addValues, addValues, addValues, buildEstimator, buildEstimator, clone, debugTipText, doNotCheckCapabilitiesTipText, equals, forName, getDebug, getDoNotCheckCapabilities, getOptions, listOptions, makeCopies, makeCopy, setDebug, setDoNotCheckCapabilities, setOptions, testCapabilities
-
Constructor Details
-
NormalEstimator
public NormalEstimator()No-arg constructor needed to make WEKA's forName() work. Uses precision of 0.01. -
NormalEstimator
public NormalEstimator(double precision) Constructor that takes a precision argument.- Parameters:
precision
- the precision to which numeric values are given. For example, if the precision is stated to be 0.1, the values in the interval (0.25,0.35] are all treated as 0.3.
-
-
Method Details
-
addValue
public void addValue(double data, double weight) Add a new data value to the current estimator.- Specified by:
addValue
in interfaceIncrementalEstimator
- Overrides:
addValue
in classEstimator
- Parameters:
data
- the new data valueweight
- the weight assigned to the data value
-
getProbability
public double getProbability(double data) Get a probability estimate for a value- Specified by:
getProbability
in classEstimator
- Parameters:
data
- the value to estimate the probability of- Returns:
- the estimated probability of the supplied value
-
toString
Display a representation of this estimator -
getCapabilities
Returns default capabilities of the classifier.- Specified by:
getCapabilities
in interfaceCapabilitiesHandler
- Overrides:
getCapabilities
in classEstimator
- Returns:
- the capabilities of this classifier
- See Also:
-
getMean
public double getMean()Return the value of the mean of this normal estimator.- Returns:
- the mean
-
getStdDev
public double getStdDev()Return the value of the standard deviation of this normal estimator.- Returns:
- the standard deviation
-
getPrecision
public double getPrecision()Return the value of the precision of this normal estimator.- Returns:
- the precision
-
getSumOfWeights
public double getSumOfWeights()Return the sum of the weights for this normal estimator.- Returns:
- the sum of the weights
-
getRevision
Returns the revision string.- Specified by:
getRevision
in interfaceRevisionHandler
- Overrides:
getRevision
in classEstimator
- Returns:
- the revision
-
aggregate
Description copied from interface:Aggregateable
Aggregate an object with this one- Specified by:
aggregate
in interfaceAggregateable<NormalEstimator>
- Parameters:
toAggregate
- the object to aggregate- Returns:
- the result of aggregation
- Throws:
Exception
- if the supplied object can't be aggregated for some reason
-
finalizeAggregation
Description copied from interface:Aggregateable
Call to complete the aggregation process. Allows implementers to do any final processing based on how many objects were aggregated.- Specified by:
finalizeAggregation
in interfaceAggregateable<NormalEstimator>
- Throws:
Exception
- if the aggregation can't be finalized for some reason
-
testAggregation
public static void testAggregation() -
main
Main method for testing this class.- Parameters:
argv
- should contain a sequence of numeric values
-