org.jpmml.evaluator

Class InstanceClassificationMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<K,Double>

org.jpmml.evaluator.ClassificationMap<String>

org.jpmml.evaluator.InstanceClassificationMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Double>, CategoricalResultFeature, Computable, HasAffinity, HasAffinityRanking, HasEntityAffinity, HasEntityId, HasEntityIdRanking, ResultFeature

@Beta
public class InstanceClassificationMap
extends ClassificationMap<String>
implements HasEntityIdRanking, HasAffinityRanking, HasEntityAffinity

See Also:

Serialized Form

Nested Class Summary

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

ClassificationMap.Type

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InstanceClassificationMap(ClassificationMap.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()
List<String>	getEntityIdRanking()
Object	getResult()

Methods inherited from class org.jpmml.evaluator.ClassificationMap

getType, normalize, normalizeSoftMax, sum, toString, toStringHelper

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get, removeEldestEntry

Methods inherited from class java.util.HashMap

clone, containsKey, entrySet, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

InstanceClassificationMap

protected InstanceClassificationMap(ClassificationMap.Type type,
                         Object result)

Method Detail

getResult

public Object getResult()

Specified by:

getResult in interface Computable

Overrides:

getResult in class ClassificationMap<String>

getCategoryValues

public Set<String> getCategoryValues()

Description copied from interface: CategoricalResultFeature

Gets the set of known categories.

Specified by:

getCategoryValues in interface CategoricalResultFeature

getEntityId

public String getEntityId()

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