gov.sandia.cognition.learning.function.distance
Class DefaultDivergenceFunctionContainer<FirstType,SecondType>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.function.distance.DefaultDivergenceFunctionContainer<FirstType,SecondType>
Type Parameters:
FirstType - The type of the first parameter to the divergence function.
SecondType - The type of the second parameter to the divergence function.
All Implemented Interfaces:
DivergenceFunctionContainer<FirstType,SecondType>, CloneableSerializable, Serializable, Cloneable
Direct Known Subclasses:
AbstractClusterToClusterDivergenceFunction, AbstractMinDistanceFixedClusterInitializer, AbstractNearestNeighbor, CentroidClusterDivergenceFunction, MedoidClusterCreator, NearestNeighborExhaustive.Learner

public class DefaultDivergenceFunctionContainer<FirstType,SecondType>
extends AbstractCloneableSerializable
implements DivergenceFunctionContainer<FirstType,SecondType>

The DefaultDivergenceFunctionContainer class implements an object that holds a divergence function. It is extended by various other classes that contain divergence functions.

Since:
2.1
Author:
Justin Basilico
See Also:
Serialized Form

Field Summary
protected  DivergenceFunction<? super FirstType,? super SecondType> divergenceFunction
          The internal divergence function for the object to use.
 
Constructor Summary
DefaultDivergenceFunctionContainer()
          Creates a new instance of DefaultDivergenceFunctionContainer.
DefaultDivergenceFunctionContainer(DefaultDivergenceFunctionContainer<? super FirstType,? super SecondType> other)
          Creates a new instance of DefaultDivergenceFunctionContainer.
DefaultDivergenceFunctionContainer(DivergenceFunction<? super FirstType,? super SecondType> divergenceFunction)
          Creates a new instance of DefaultDivergenceFunctionContainer.
 
Method Summary
 DefaultDivergenceFunctionContainer<FirstType,SecondType> clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 DivergenceFunction<? super FirstType,? super SecondType> getDivergenceFunction()
          Gets the divergence function used by this object.
 void setDivergenceFunction(DivergenceFunction<? super FirstType,? super SecondType> divergenceFunction)
          Sets the divergence function used by this object.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

divergenceFunction

protected DivergenceFunction<? super FirstType,? super SecondType> divergenceFunction
The internal divergence function for the object to use.

Constructor Detail

DefaultDivergenceFunctionContainer

public DefaultDivergenceFunctionContainer()
Creates a new instance of DefaultDivergenceFunctionContainer.


DefaultDivergenceFunctionContainer

public DefaultDivergenceFunctionContainer(DivergenceFunction<? super FirstType,? super SecondType> divergenceFunction)
Creates a new instance of DefaultDivergenceFunctionContainer.

Parameters:
divergenceFunction - The divergence function.

DefaultDivergenceFunctionContainer

public DefaultDivergenceFunctionContainer(DefaultDivergenceFunctionContainer<? super FirstType,? super SecondType> other)
Creates a new instance of DefaultDivergenceFunctionContainer.

Parameters:
other - The other object to copy.
Method Detail

clone

public DefaultDivergenceFunctionContainer<FirstType,SecondType> clone()
Description copied from class: AbstractCloneableSerializable
This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

getDivergenceFunction

public DivergenceFunction<? super FirstType,? super SecondType> getDivergenceFunction()
Gets the divergence function used by this object.

Specified by:
getDivergenceFunction in interface DivergenceFunctionContainer<FirstType,SecondType>
Returns:
The divergence function.

setDivergenceFunction

public void setDivergenceFunction(DivergenceFunction<? super FirstType,? super SecondType> divergenceFunction)
Sets the divergence function used by this object.

Parameters:
divergenceFunction - The divergence function.