Package com.namsor.oss.classify.bayes

Class ClassificationImpl

java.lang.Object

com.namsor.oss.classify.bayes.ClassificationImpl

All Implemented Interfaces:

IClassification

public class ClassificationImpl
extends Object
implements IClassification

An immutable classification object

Author:

elian

Constructor Summary

Constructors

Constructor	Description
ClassificationImpl(Map<String,String> features, IClassProbability[] classProbabilities, Map<String,Long> explanationData)
ClassificationImpl(Map<String,String> features, IClassProbability[] classProbabilities, Map<String,Long> explanationData, boolean laplaceSmoothed, boolean laplaceSmoothedVariant, double laplaceSmoothingAlpha)

Method Summary

Modifier and Type	Method	Description
IClassProbability[]	getClassProbabilities()	The ordered classes and probabilities.
Map<String,Long>	getExplanationData()	All the data needed to explain the results.
Map<String,String>	getFeatures()	The input features
double	getLaplaceSmoothingAlpha()	The alpha value used for Laplace smoothing
boolean	isLaplaceSmoothed()	Is Laplace smoothed?
boolean	isLaplaceSmoothedVariant()	If Laplace Smoothed With variant, then: likelyhood[i] = 1d * ((categoryCount + alpha) / (globalCount + globalCountCategories * alpha)) * product; otherwise: likelyhood[i] = 1d * categoryCount / globalCount * product;

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassificationImpl

public ClassificationImpl(Map<String,String> features,
                          IClassProbability[] classProbabilities,
                          Map<String,Long> explanationData,
                          boolean laplaceSmoothed,
                          boolean laplaceSmoothedVariant,
                          double laplaceSmoothingAlpha)

ClassificationImpl

public ClassificationImpl(Map<String,String> features,
                          IClassProbability[] classProbabilities,
                          Map<String,Long> explanationData)

Method Detail

getClassProbabilities

public IClassProbability[] getClassProbabilities()

Description copied from interface: IClassification

The ordered classes and probabilities.

Specified by:

getClassProbabilities in interface IClassification

Returns:

the classProbabilities

getExplanationData

public Map<String,Long> getExplanationData()

Description copied from interface: IClassification

All the data needed to explain the results.

Specified by:

getExplanationData in interface IClassification

Returns:

the explanation

isLaplaceSmoothed

public boolean isLaplaceSmoothed()

Description copied from interface: IClassification

Is Laplace smoothed?

Specified by:

isLaplaceSmoothed in interface IClassification

Returns:

the laplaceSmoothed

isLaplaceSmoothedVariant

public boolean isLaplaceSmoothedVariant()

Description copied from interface: IClassification

If Laplace Smoothed With variant, then: likelyhood[i] = 1d * ((categoryCount + alpha) / (globalCount + globalCountCategories * alpha)) * product; otherwise: likelyhood[i] = 1d * categoryCount / globalCount * product;

Specified by:

isLaplaceSmoothedVariant in interface IClassification

Returns:

the laplaceSmoothedVariant

getFeatures

public Map<String,String> getFeatures()

Description copied from interface: IClassification

The input features

Specified by:

getFeatures in interface IClassification

Returns:

the features

getLaplaceSmoothingAlpha

public double getLaplaceSmoothingAlpha()

Description copied from interface: IClassification

The alpha value used for Laplace smoothing

Specified by:

getLaplaceSmoothingAlpha in interface IClassification

Returns:

the laplaceSmoothingAlpha