Package org.jpmml.evaluator

Class ProbabilityDistribution<V extends Number>

java.lang.Object

org.jpmml.evaluator.AbstractComputable

org.jpmml.evaluator.Classification<Object,V>

org.jpmml.evaluator.ProbabilityDistribution<V>

All Implemented Interfaces:

CategoricalResultFeature<Object>, Computable, HasPrediction, HasProbability, ResultFeature

Direct Known Subclasses:

AggregateProbabilityDistribution

public class ProbabilityDistribution<V extends Number>
extends Classification<Object,V>
implements HasProbability

Nested Class Summary

Nested classes/interfaces inherited from class org.jpmml.evaluator.Classification

Classification.Type

Constructor Summary

Constructors

Constructor	Description
ProbabilityDistribution(ValueMap<Object,V> probabilities)

Method Summary

Modifier and Type	Method	Description
Set<Object>	getCategories()	Gets the set of known categories.
Double	getProbability(Object category)	Gets the probability of the specified category.
Report	getProbabilityReport(Object category)

Methods inherited from class org.jpmml.evaluator.Classification

entryKeys, entryValues, getPrediction, getPredictionReport, getResult, getType, getValue, getValueReport, getValues, getWinner, getWinnerList, put

Methods inherited from class org.jpmml.evaluator.AbstractComputable

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProbabilityDistribution

public ProbabilityDistribution(ValueMap<Object,V> probabilities)

Method Detail

getCategories

public Set<Object> getCategories()

Description copied from interface: CategoricalResultFeature

Gets the set of known categories.

The set of known categories either equals the set of all categories, or is a proper subset of it.

Specified by:

getCategories in interface CategoricalResultFeature<V extends Number>

getProbability

public Double getProbability(Object category)

Description copied from interface: HasProbability

Gets the probability of the specified category.

Specified by:

getProbability in interface HasProbability

Returns:

A probability in the range from 0.0 to 1.0. The probability of an unknown category is 0.0.

See Also:

CategoricalResultFeature.getCategories()

getProbabilityReport

public Report getProbabilityReport(Object category)

Specified by:

getProbabilityReport in interface HasProbability

See Also:

CategoricalResultFeature.getCategories()