org.jpmml.evaluator

Class AffinityDistribution

java.lang.Object

org.jpmml.evaluator.Classification

org.jpmml.evaluator.AffinityDistribution

All Implemented Interfaces:

CategoricalResultFeature, Computable, HasAffinity, HasAffinityRanking, HasEntityAffinity, HasEntityId, HasEntityIdRanking, ResultFeature

public class AffinityDistribution
extends Classification
implements HasEntityIdRanking, HasAffinityRanking, HasEntityAffinity

Nested Class Summary

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

Classification.Type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AffinityDistribution(Classification.Type type, Object result)

Method Summary

Methods

Modifier and Type	Method and Description
Double	getAffinity(String id) Gets the affinity towards the specified category.
List<Double>	getAffinityRanking() Gets the affinities for known categories.
Set<String>	getCategoryValues() Gets the set of known categories.
Double	getEntityAffinity() Gets the affinity towards the winning entity.
String	getEntityId() Gets the Entity identifier.
List<String>	getEntityIdRanking()
protected static Classification.Type	validateType(Classification.Type type)

Methods inherited from class org.jpmml.evaluator.Classification

entryKeys, entryValues, getResult, getType, normalize, normalizeSoftMax, sum, toString, toStringHelper

Methods inherited from class java.lang.Object

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

Constructor Detail

AffinityDistribution

protected AffinityDistribution(Classification.Type type,
                    Object result)

Method Detail

getCategoryValues

public Set<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

getEntityId

public String getEntityId()

Description copied from interface: HasEntityId

Gets the Entity identifier.

Specified by:

getEntityId in interface HasEntityId

getEntityIdRanking

public List<String> getEntityIdRanking()

Specified by:

getEntityIdRanking in interface HasEntityIdRanking

getAffinity

public Double getAffinity(String id)

Description copied from interface: HasAffinity

Gets the affinity towards the specified category.

Specified by:

getAffinity in interface HasAffinity

Returns:

An affinity in the range from 0.0 to positive infinity. The affinity of an unknown category is the least optimal value in the range of valid values (ie. Double.POSITIVE_INFINITY for distance measures and 0.0 for similarity measures).

See Also:

CategoricalResultFeature.getCategoryValues()

getAffinityRanking

public List<Double> getAffinityRanking()

Description copied from interface: HasAffinityRanking

Gets the affinities for known categories.

Affinities are ordered from the most optimal one to the least optimal one.

Specified by:

getAffinityRanking in interface HasAffinityRanking

getEntityAffinity

public Double getEntityAffinity()

Description copied from interface: HasEntityAffinity

Gets the affinity towards the winning entity.

Specified by:

getEntityAffinity in interface HasEntityAffinity

validateType

protected static Classification.Type validateType(Classification.Type type)