org.jpmml.evaluator

Class EntityProbabilityDistribution<E extends org.dmg.pmml.Entity>

java.lang.Object

org.jpmml.evaluator.Classification

org.jpmml.evaluator.EntityClassification<E>

org.jpmml.evaluator.EntityProbabilityDistribution<E>

All Implemented Interfaces:

CategoricalResultFeature, Computable, HasEntityId, HasEntityRegistry<E>, HasProbability, ResultFeature

public class EntityProbabilityDistribution<E extends org.dmg.pmml.Entity>
extends EntityClassification<E>
implements HasProbability

Nested Class Summary

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

Classification.Type

Constructor Summary

Constructors

Constructor and Description
EntityProbabilityDistribution(com.google.common.collect.BiMap<java.lang.String,E> entityRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getCategoryValues() Gets the set of known categories.
java.lang.Double	getProbability(java.lang.String value) Gets the probability of the specified category.

Methods inherited from class org.jpmml.evaluator.EntityClassification

getEntity, getEntityId, getEntityRegistry, put, setEntity, toStringHelper

Methods inherited from class org.jpmml.evaluator.Classification

computeResult, createOrdering, entryKeys, entrySet, entryValues, get, getResult, getType, getWinner, getWinner, getWinnerKeys, getWinnerList, getWinnerRanking, getWinnerValues, isEmpty, keySet, normalize, normalizeSoftMax, normalizeValues, put, setResult, sum, sumValues, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityProbabilityDistribution

public EntityProbabilityDistribution(com.google.common.collect.BiMap<java.lang.String,E> entityRegistry)

Method Detail

getCategoryValues

public java.util.Set<java.lang.String> getCategoryValues()

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:

getCategoryValues in interface CategoricalResultFeature

getProbability

public java.lang.Double getProbability(java.lang.String value)

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.getCategoryValues()