org.jpmml.evaluator

Class ClusterClassificationMap

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.EntityClassificationMap<org.dmg.pmml.Cluster>

org.jpmml.evaluator.ClusterClassificationMap

All Implemented Interfaces:

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

@Beta
public class ClusterClassificationMap
extends EntityClassificationMap<org.dmg.pmml.Cluster>
implements HasDisplayValue, HasAffinity, 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	ClusterClassificationMap(ClassificationMap.Type type)
protected	ClusterClassificationMap(ClassificationMap.Type type, org.dmg.pmml.Cluster cluster)

Method Summary

Methods

Modifier and Type	Method and Description
Double	getAffinity(String value) Gets the affinity towards the specified category.
Set<String>	getCategoryValues() Gets the set of known categories.
String	getDisplayValue()
Double	getEntityAffinity() Gets the affinity towards the winning entity.

Methods inherited from class org.jpmml.evaluator.EntityClassificationMap

getEntity, getEntityId, getResult, toStringHelper

Methods inherited from class org.jpmml.evaluator.ClassificationMap

getType, normalize, normalizeSoftMax, sum, toString

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

ClusterClassificationMap

protected ClusterClassificationMap(ClassificationMap.Type type)

ClusterClassificationMap

protected ClusterClassificationMap(ClassificationMap.Type type,
                        org.dmg.pmml.Cluster cluster)

Method Detail

getCategoryValues

public Set<String> getCategoryValues()

Description copied from interface: CategoricalResultFeature

Gets the set of known categories.

Specified by:

getCategoryValues in interface CategoricalResultFeature

getDisplayValue

public String getDisplayValue()

Specified by:

getDisplayValue in interface HasDisplayValue

getAffinity

public Double getAffinity(String value)

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

getEntityAffinity

public Double getEntityAffinity()

Description copied from interface: HasEntityAffinity

Gets the affinity towards the winning entity.

Specified by:

getEntityAffinity in interface HasEntityAffinity