gov.sandia.cognition.learning.function.distance

Class IdentityDistanceMetric

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.learning.function.distance.IdentityDistanceMetric

All Implemented Interfaces:

DivergenceFunction<java.lang.Object,java.lang.Object>, Metric<java.lang.Object>, Semimetric<java.lang.Object>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

public class IdentityDistanceMetric
extends AbstractCloneableSerializable
implements Metric<java.lang.Object>

A distance metric that is 0 if two objects are equal and 1 if they are not. Can be used with any object with a valid equals method.

Since:

3.3.3

Author:

Justin Basilico

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IdentityDistanceMetric() Creates a new IdentityDistanceMetric.

Method Summary

Modifier and Type	Method and Description
double	evaluate(java.lang.Object first, java.lang.Object second) Evaluates the divergence between the two given objects.

Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable

clone

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityDistanceMetric

public IdentityDistanceMetric()

Creates a new IdentityDistanceMetric.

Method Detail

evaluate

public double evaluate(java.lang.Object first,
                       java.lang.Object second)

Description copied from interface: DivergenceFunction

Evaluates the divergence between the two given objects.

Specified by:

evaluate in interface DivergenceFunction<java.lang.Object,java.lang.Object>

Parameters:

first - The first object.

second - The second object.

Returns:

The divergence between the objects.